Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
W
WIE_202021_CSBillero11
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Bernard Roland (Student Com20)
WIE_202021_CSBillero11
Commits
0ac73f13
Commit
0ac73f13
authored
3 years ago
by
Bernard Roland (Student Com20)
Browse files
Options
Downloads
Patches
Plain Diff
Updated the README.md
parent
e8f80c07
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+11
-10
11 additions, 10 deletions
README.md
with
11 additions
and
10 deletions
README.md
+
11
−
10
View file @
0ac73f13
...
...
@@ -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 complet
e
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 possibl
e
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
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment