update readme with setup
This commit is contained in:
Sorrel Bri
parent
f2c0ce62fe
commit
a1f7c45536
4 changed files with 83 additions and 15 deletions
83
README.md
83
README.md
|
|
@ -5,6 +5,89 @@ A browser application to play Go in real time.
|
|||
[The project in it's current state](https://play-node-go.herokuapp.com/)
|
||||
[Client only prototype](https://sorrelbri.github.io/browser-go-proto/)
|
||||
|
||||
## Setup
|
||||
### Local Repo
|
||||
```sh
|
||||
$ git clone https://github.com/sorrelbri/node-go.git
|
||||
```
|
||||
|
||||
### Install Deps
|
||||
```sh
|
||||
$ npm run bootstrap
|
||||
```
|
||||
Runs lerna `bootstrap` command installing dependencies for project, development and package dependencies
|
||||
|
||||
### Initialize Database
|
||||
#### Download PostgreSQL
|
||||
To verify PostgreSQL installation:
|
||||
```sh
|
||||
$ psql -V
|
||||
```
|
||||
Node Go API was built with version 11.4.
|
||||
[See documentation for Postgres download.](https://www.postgresql.org/download/)
|
||||
|
||||
#### Create Databases
|
||||
```sh
|
||||
$ psql
|
||||
# psql(11.4)
|
||||
```
|
||||
```sql
|
||||
CREATE DATABASE node-go;
|
||||
CREATE DATABASE node-go-test; # testing database
|
||||
```
|
||||
|
||||
### Configure Environment
|
||||
```sh
|
||||
$ touch packages/server/.env
|
||||
```
|
||||
|
||||
```
|
||||
# .env
|
||||
NODE_ENV=development
|
||||
PORT=# set development port for API
|
||||
REACT_ADDRESS=http://localhost:3000 # default
|
||||
PG_CONNECTION_STRING=postgresql://localhost:5432/node-go
|
||||
PG_CONNECTION_STRING_TEST=postgresql://localhost:5432/node-go-test
|
||||
JWT_SECRET=# generate a secret key for JWT signing algorithm
|
||||
TEST_SECRET=# same as above, for test environment
|
||||
SALT_ROUNDS=# set number of salt rounds for bcrypt hashing function
|
||||
DOMAIN=localhost
|
||||
USER_ONE_PASSWORD=# credentials for testing with
|
||||
USER_ONE_EMAIL=# same as above
|
||||
```
|
||||
|
||||
### Smoke test
|
||||
```sh
|
||||
$ lerna run test
|
||||
```
|
||||
|
||||
### Run Database Migrations
|
||||
```sh
|
||||
$ cd packages/server; npm run migrate; npm run seed
|
||||
```
|
||||
|
||||
### Running in development
|
||||
```sh
|
||||
$ cd packages/server
|
||||
$ npm start # or if you have nodemon
|
||||
$ nodemon
|
||||
```
|
||||
```sh
|
||||
$ cd packages/play-node-go
|
||||
$ npm start
|
||||
```
|
||||
|
||||
## Known Bugs
|
||||
- server side move validation not complete, full game logic not implemented
|
||||
- no authorization for game moves
|
||||
- websocket connections may remain open, pooling prevents runaway leaks, but tests may hang
|
||||
|
||||
## Roadmap 4/20
|
||||
1. Game logic module
|
||||
2. Game in progress caching
|
||||
3. Auth for games
|
||||
4. Game request creation
|
||||
|
||||
## Features
|
||||
- [ ] Realtime communications
|
||||
- [ ] Multiple game settings
|
||||
|
|
|
|||
|
|
@ -1,8 +0,0 @@
|
|||
`hk-api=https://git.heroku.com/node-go-api.git`
|
||||
`hk-play=https://git.heroku.com/play-node-go.git`
|
||||
|
||||
### Server
|
||||
`$ git subtree push --prefix packages/server hk-api master`
|
||||
|
||||
### React
|
||||
`$ git subtree push --prefix packages/play-node-go hk-play master`
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 841.9 595.3">
|
||||
<g fill="#61DAFB">
|
||||
<path d="M666.3 296.5c0-32.5-40.7-63.3-103.1-82.4 14.4-63.6 8-114.2-20.2-130.4-6.5-3.8-14.1-5.6-22.4-5.6v22.3c4.6 0 8.3.9 11.4 2.6 13.6 7.8 19.5 37.5 14.9 75.7-1.1 9.4-2.9 19.3-5.1 29.4-19.6-4.8-41-8.5-63.5-10.9-13.5-18.5-27.5-35.3-41.6-50 32.6-30.3 63.2-46.9 84-46.9V78c-27.5 0-63.5 19.6-99.9 53.6-36.4-33.8-72.4-53.2-99.9-53.2v22.3c20.7 0 51.4 16.5 84 46.6-14 14.7-28 31.4-41.3 49.9-22.6 2.4-44 6.1-63.6 11-2.3-10-4-19.7-5.2-29-4.7-38.2 1.1-67.9 14.6-75.8 3-1.8 6.9-2.6 11.5-2.6V78.5c-8.4 0-16 1.8-22.6 5.6-28.1 16.2-34.4 66.7-19.9 130.1-62.2 19.2-102.7 49.9-102.7 82.3 0 32.5 40.7 63.3 103.1 82.4-14.4 63.6-8 114.2 20.2 130.4 6.5 3.8 14.1 5.6 22.5 5.6 27.5 0 63.5-19.6 99.9-53.6 36.4 33.8 72.4 53.2 99.9 53.2 8.4 0 16-1.8 22.6-5.6 28.1-16.2 34.4-66.7 19.9-130.1 62-19.1 102.5-49.9 102.5-82.3zm-130.2-66.7c-3.7 12.9-8.3 26.2-13.5 39.5-4.1-8-8.4-16-13.1-24-4.6-8-9.5-15.8-14.4-23.4 14.2 2.1 27.9 4.7 41 7.9zm-45.8 106.5c-7.8 13.5-15.8 26.3-24.1 38.2-14.9 1.3-30 2-45.2 2-15.1 0-30.2-.7-45-1.9-8.3-11.9-16.4-24.6-24.2-38-7.6-13.1-14.5-26.4-20.8-39.8 6.2-13.4 13.2-26.8 20.7-39.9 7.8-13.5 15.8-26.3 24.1-38.2 14.9-1.3 30-2 45.2-2 15.1 0 30.2.7 45 1.9 8.3 11.9 16.4 24.6 24.2 38 7.6 13.1 14.5 26.4 20.8 39.8-6.3 13.4-13.2 26.8-20.7 39.9zm32.3-13c5.4 13.4 10 26.8 13.8 39.8-13.1 3.2-26.9 5.9-41.2 8 4.9-7.7 9.8-15.6 14.4-23.7 4.6-8 8.9-16.1 13-24.1zM421.2 430c-9.3-9.6-18.6-20.3-27.8-32 9 .4 18.2.7 27.5.7 9.4 0 18.7-.2 27.8-.7-9 11.7-18.3 22.4-27.5 32zm-74.4-58.9c-14.2-2.1-27.9-4.7-41-7.9 3.7-12.9 8.3-26.2 13.5-39.5 4.1 8 8.4 16 13.1 24 4.7 8 9.5 15.8 14.4 23.4zM420.7 163c9.3 9.6 18.6 20.3 27.8 32-9-.4-18.2-.7-27.5-.7-9.4 0-18.7.2-27.8.7 9-11.7 18.3-22.4 27.5-32zm-74 58.9c-4.9 7.7-9.8 15.6-14.4 23.7-4.6 8-8.9 16-13 24-5.4-13.4-10-26.8-13.8-39.8 13.1-3.1 26.9-5.8 41.2-7.9zm-90.5 125.2c-35.4-15.1-58.3-34.9-58.3-50.6 0-15.7 22.9-35.6 58.3-50.6 8.6-3.7 18-7 27.7-10.1 5.7 19.6 13.2 40 22.5 60.9-9.2 20.8-16.6 41.1-22.2 60.6-9.9-3.1-19.3-6.5-28-10.2zM310 490c-13.6-7.8-19.5-37.5-14.9-75.7 1.1-9.4 2.9-19.3 5.1-29.4 19.6 4.8 41 8.5 63.5 10.9 13.5 18.5 27.5 35.3 41.6 50-32.6 30.3-63.2 46.9-84 46.9-4.5-.1-8.3-1-11.3-2.7zm237.2-76.2c4.7 38.2-1.1 67.9-14.6 75.8-3 1.8-6.9 2.6-11.5 2.6-20.7 0-51.4-16.5-84-46.6 14-14.7 28-31.4 41.3-49.9 22.6-2.4 44-6.1 63.6-11 2.3 10.1 4.1 19.8 5.2 29.1zm38.5-66.7c-8.6 3.7-18 7-27.7 10.1-5.7-19.6-13.2-40-22.5-60.9 9.2-20.8 16.6-41.1 22.2-60.6 9.9 3.1 19.3 6.5 28.1 10.2 35.4 15.1 58.3 34.9 58.3 50.6-.1 15.7-23 35.6-58.4 50.6zM320.8 78.4z"/>
|
||||
<circle cx="420.9" cy="296.5" r="45.7"/>
|
||||
<path d="M520.5 78.1z"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 2.6 KiB |
Loading…
Reference in a new issue