Clean up README instructions

This commit is contained in:
Anthony Wang 2022-01-13 12:21:27 -06:00
parent aad9977d79
commit de461a3da4
Signed by: a
GPG key ID: BC96B00AEC5F2D76

View file

@ -2,10 +2,12 @@
A subversive card game.
## Getting started
`git clone` this repository, then run `npm install` in `front` and `back`. You may have to run it multiple times for it to pull in all dependencies.
Clone this repository, then run `npm install` in `front` and `back`.
## Developing
You can use `NEXT_PUBLIC_BACK_HOST=localhost:4000 npm run dev` to run the frontend and `PORT=4000 node dist/index.js` to run the backend after building it with `npm run build`. You could also just run `NEXT_PUBLIC_BACK_HOST='https://server.exozy.me' npm run dev` if you are only developing the frontend and connect to the public backend server.
You can use `npm run build` to build the frontend and backend. Use `NEXT_PUBLIC_BACK_HOST=localhost:4000 npm run dev` to run the frontend and `PORT=4000 node dist/index.js` to run the backend.
You could also run `NEXT_PUBLIC_BACK_HOST='https://server.exozy.me' npm run dev` if you are only developing the frontend and connecting to the public backend server.
## Production deployment
Edit the environmental variables in `./env` and use the script `./run`.
Edit and run the script `./run`.