b541ddc2335ff88c5a165c5ea794ae36a49a166b
[vchess.git] / README.md
1 # v[ariant]chess.club
2
3 Website to play to many chess variants, including rare ones - some almost
4 never seen elsewhere, like "l'Échiqueté" [french], renamed "checkered chess"
5 in english.
6
7 ## Usage
8
9 I hope it's intuitive enough :)
10
11 But, a few important points:
12 - All games start with a random assymetric position!
13 - Games are untimed: you decide to play fast or not...
14 - Your identity (if filled) is revealed only after the game
15
16 ## Resources
17
18 Server side:
19 - node,
20 - npm packages (see package.json),
21
22 Client side:
23 - Vue.js,
24 - underscore.js,
25 - mini.css,
26 - Google font 'Open Sans' + a few icons,
27
28 Sounds and pieces images where found at various locations.
29
30 ## Installation (for developers)
31
32 0. Install git-fat https://github.com/jedbrown/git-fat
33 1. git fat init && git fat pull
34 2. Execute db/\*.sql scripts to create and fill db/vchess.sqlite
35 3. Rename and edit public/javascripts/socket\_url.js.dist into socket\_url.js
36 4. npm i && npm start
37
38 ## Get involved
39
40 All contributions are welcome! For example,
41 - translations,
42 - design,
43 - Vue front-end,
44 - Express back-end.
45
46 If you wanna help, you can send me an email (address indicated in the "Help"
47 menu on the website) so that we can discuss what to do and how :)
48 If you feel comfortable with the code a pull request is a good start too.