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

[vchess.git] / client / README.md

diff --git a/client/README.md b/client/README.md
new file mode 100644 (file)
index 0000000..0b7fbe4
--- /dev/null
+++ b/client/README.md
@@ -0,0 +1,34 @@
+# vchess-client
+
+## Project setup
+Rename and edit src/socket\_url.js.dist into socket\_url.js
+```
+npm install
+```
+
+### Compiles and hot-reloads for development
+```
+npm run serve
+```
+
+### Compiles and minifies for production
+```
+npm run build
+```
+
+### Lints and fixes files
+```
+npm run lint
+```
+
+### Customize configuration
+See [Configuration Reference](https://cli.vuejs.org/config/).
+
+## Resources
+
+ - Vue.js + Vue router,
+ - Underscore.js,
+ - mini.css,
+ - Google font 'Open Sans' + a few icons,
+
+Sounds and pieces images where found at various locations.