README.md

   1 # v[ariant]chess.club
   2
   3 Website to play to many chess variants, including rare ones - some almost never seen
   4 elsewhere, like "l'Échiqueté" [french], renamed "checkered chess" in english.
   5
   6 ## Usage
   7
   8 I hope it's intuitive enough :)
   9
  10 But, 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  - Your identity (if filled) is revealed only after the 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/create.sql script (SQLite) to fill db/vchess.sqlite database
  34  3. Rename public/javascripts/socket\_url.js.dist into socket\_url.js
  35     and adjust its content.
  36  4. npm i && npm start