Add Shogun Chess
[vchess.git] / server / README.md
CommitLineData
625022fd
BA
1# vchess-server
2
68ff3913 3Instructions to run the server locally.
625022fd 4
68ff3913 5## Requirements
625022fd 6
f5f82ba6
BA
7- Node.js + npm (any recent version)
8- SQLite (version 3)
625022fd 9
68ff3913
BA
10## Installation
11
f5f82ba6 121. Execute db/\*.sql scripts to create and fill db/vchess.sqlite
68ff3913 13
94b800a4 14```
15cd server/db
1ad88021 16sqlite3 vchess.sqlite
94b800a4 17sqlite> .read create.sql
18sqlite> .read populate.sql
19sqlite> .exit
20```
21
91cd09d8
BA
222. Rename and edit `db/dbconnect.py.dist` into `db/dbconnect.py`.
23Then synchronize the GameStat table:
24
25```
26./sync_gamestat.py
27```
28
f5f82ba6 292. Rename and edit `config/parameters.js.dist` into `config/parameters.js`
94b800a4 30
f5f82ba6 313. Install npm modules
94b800a4 32
f5f82ba6
BA
33```
34npm install
35```
36
37## Running
94b800a4 38
68ff3913
BA
39```
40npm start
41```