Skip to content
Snippets Groups Projects
Commit 0ac73f13 authored by Bernard Roland (Student Com20)'s avatar Bernard Roland (Student Com20)
Browse files

Updated the README.md

parent e8f80c07
No related branches found
No related tags found
No related merge requests found
......@@ -21,13 +21,13 @@ You can test out our web application at https://ryoko-planning.herokuapp.com/.
### Simple deployment
If you have [yarn](https://yarnpkg.com/) installed it is possible to build and start the complete
project the same way it is deployed on our server. For this simply enter the root directory of the
repository and execute the following three command in order:
If you have [yarn](https://yarnpkg.com/) or [npm](https://www.npmjs.com/) installed it is possible
to build and start the complete project the same way it is deployed on our server.
For this simply enter the root directory of the repository and execute the following three command in order:
1. `yarn install` This will install all the dependencies for both the frontend and backend
2. `yarn build` This will bundle the source for the frontend and transpile backend
3. `yarn start` This will start the web server and host the webserver at `localhost:8000`
1. `yarn install` (or `npm install`) This will install all the dependencies for both the frontend and backend
2. `yarn build` (or `npm run build`) This will bundle the source for the frontend and transpile backend
3. `yarn start` (or `npm run start`) This will start the web server and host the webserver at `localhost:8000`
Note:
* The server can use a public and private key pair to sign the authentication web token. They can
......@@ -37,7 +37,8 @@ envirenvironment variables. In any case the keys must be suitable for ES384 sign
keys are not given it will use a simple password to sign the tokens.
* If your `PORT` environment variable is set that will be used as the port to host the webserver in stead of port 8000.
* If your `NODE_ENV` environment variable is set to `production` (with SSL) or `staging` (without SSL) the server will try
to connect to a postgres database using the connection url inside `DATABASE_URL`.
to connect to a postgres database using the connection url inside `DATABASE_URL` or
`postgresql://postgres@localhost/ryoko` if no such variable is present in the environment.
### Details
......@@ -48,19 +49,19 @@ server and client parts also use the same commands for running building and test
Before building or running you will have to make sure that you have installed all dependencies. This
can be done by executing `yarn install` (or `npm install --legacy-peer-deps`).
### How to Run
#### How to Run
To start a development server you can execute `yarn start` (or `npm run start`) inside the `server`
and the `client` directories. Most parts of the client will also require the server to be running
simultaneously.
### How to Build
#### How to Build
To build a production build enter the respective directory (either `server` or `client`) and execute
`yarn build` (or `npm run build`). The build output will be created inside a directory named `build`
and can then be executed using node for the server, or served staticaly for the client.
### How to Use
#### How to Use
After starting the development server inside `client`, the website is accessible at
`http://localhost:3000`. Depending on your configuration the site will probably be opened
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment