Update TODO
[vchess.git] / README.md
CommitLineData
1d184b4c
BA
1# v[ariant]chess.club
2
3Website to play to many chess variants, including rare ones - some almost never seens
4elsewhere, like "l'Échiqueté" [french], renamed "checkered chess" in english.
5
6## Usage
7
8I hope it's intuitive enough :)
9
10But, a few important points:
11 - All games start with a random assymetric position!
12 - Games are untimed: you decide to play fast or not...
13
14## Resources
15
16Server side:
17 - node + npm packages (see package.json),
18 - pug,
19
20Client side:
21 - Vue.js,
22 - underscore.js
23 - mini.css,
24 - Google font 'Open Sans' + a few icons,
25
26Pieces images where found at various locations.
27
28## Installation (for developers)
29
30 0. Install git-fat https://github.com/jedbrown/git-fat
31 1. Rename public/javascripts/utils/socket\_url.js.dist into socket\_url.js and adjust its content.
32 2. git fat init && git fat pull
33 3. npm i && npm start