X-Git-Url: https://git.auder.net/?p=vchess.git;a=blobdiff_plain;f=server%2FREADME.md;h=9adba7adf81a302f8b89e256f7fb96b0d8cb6d58;hp=8fa26425adc24a748d57b140a6d451ded42ae415;hb=68ff39135865a7b68d36b9f0be2633f5296ab091;hpb=5668f4ddc47487f7b7316ac005ba5627285d73ec diff --git a/server/README.md b/server/README.md index 8fa26425..9adba7ad 100644 --- a/server/README.md +++ b/server/README.md @@ -1,15 +1,19 @@ # vchess-server -## Resources +Instructions to run the server locally. - - Node.js, - - Express, - - Other npm packages (see package.json), +## Requirements -## Installation (for developers) + - Node.js + npm (any recent version) + - SQLite (version 3) - 0. Install git-fat https://github.com/jedbrown/git-fat - 1. git fat init && git fat pull - 2. Execute db/\*.sql scripts to create and fill db/vchess.sqlite - 3. Rename and edit config/parameters.js.dist into parameters.js - 4. npm i && npm start +## Installation + + 1. Execute db/\*.sql scripts to create and fill db/vchess.sqlite + 2. Rename and edit config/parameters.js.dist into parameters.js + 3. npm install + +Then run with the command +``` +npm start +```