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