aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAnthony Wang2021-05-09 18:28:37 +0000
committerGitHub2021-05-09 18:28:37 +0000
commitdf75aa721e89c8c5798fc53e9404413b1ade8106 (patch)
tree7070feb93cbd90976956bce5574178730b41945f /README.md
parent013018ecaefe1814eb3fb3ed366bf062220822ab (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index 9f8f7e8..7b2c48a 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,11 @@
# BSX
-The card game BS, but better! Currently under development.
+The card game BS, but better!
-## Production deployment
-
-Edit the environmental variables in `./env` and use the script `./run`.
+## 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.
## 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 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.
+
+## Production deployment
+Edit the environmental variables in `./env` and use the script `./run`.