Separate client and server codes. Keep everything in one git repo for simplicity

[vchess.git] / server / README.md

diff --git a/server/README.md b/server/README.md
new file mode 100644 (file)
index 0000000..8fa2642
--- /dev/null
+++ b/server/README.md
@@ -0,0 +1,15 @@
+# vchess-server
+
+## Resources
+
+ - Node.js,
+ - Express,
+ - Other npm packages (see package.json),
+
+## Installation (for developers)
+
+ 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