[vchess.git] / server / README.md

# vchess-server

Instructions to run the server locally.

## Requirements

- Node.js + npm (any recent version)
- SQLite (version 3)

## Installation

1. Execute db/\*.sql scripts to create and fill db/vchess.sqlite

```
cd server/db
sqlite3 vchess.sqlite
sqlite> .read create.sql
sqlite> .read populate.sql
sqlite> .exit
```

2. Rename and edit `config/parameters.js.dist` into `config/parameters.js`

3. Install npm modules

```
npm install
```

## Running

```
npm start
```
Commit	Line	Data
	1	# vchess-server
	2
	3	Instructions to run the server locally.
	4
	5	## Requirements
	6
	7	- Node.js + npm (any recent version)
	8	- SQLite (version 3)
	9
	10	## Installation
	11
	12	1. Execute db/\*.sql scripts to create and fill db/vchess.sqlite
	13
	14	```
	15	cd server/db
	16	sqlite3 vchess.sqlite
	17	sqlite> .read create.sql
	18	sqlite> .read populate.sql
	19	sqlite> .exit
	20	```
	21
	22	2. Rename and edit `config/parameters.js.dist` into `config/parameters.js`
	23
	24	3. Install npm modules
	25
	26	```
	27	npm install
	28	```
	29
	30	## Running
	31
	32	```
	33	npm start
	34	```