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  - Games start with a random assymetric position!
  13  - Your identity is revealed only after a game
  14
  15 ## Resources
  16
  17 Server side:
  18  - node,
  19  - npm packages (see package.json),
  20
  21 Client side:
  22  - Vue.js,
  23  - underscore.js,
  24  - mini.css,
  25  - Google font 'Open Sans' + a few icons,
  26
  27 Sounds and pieces images where found at various locations.
  28
  29 ## Installation (for developers)
  30
  31  0. Install git-fat https://github.com/jedbrown/git-fat
  32  1. git fat init && git fat pull
  33  2. Execute db/\*.sql scripts to create and fill db/vchess.sqlite
  34  3. Rename and edit public/javascripts/socket\_url.js.dist into socket\_url.js
  35  4. npm i && npm start
  36
  37 ## Get involved
  38
  39 All contributions are welcome! For example,
  40  - translations,
  41  - design,
  42  - Vue front-end,
  43  - Express back-end.
  44
  45 If you wanna help, you can send me an email (address indicated in the "Help"
  46 menu on the website) so that we can discuss what to do and how :)
  47 If you feel comfortable with the code a pull request is a good start too.