# v[ariant]chess.club
-Website to play to many chess variants, including rare ones - some almost never seens
-elsewhere, like "l'Échiqueté" [french], renamed "checkered chess" in english.
+Website to play to many chess variants, including rare ones - some almost
+never seen elsewhere, like "l'Échiqueté" [french], renamed "checkered chess"
+in english.
-## Usage
-
-I hope it's intuitive enough :)
-
-But, a few important points:
- - All games start with a random assymetric position!
- - Games are untimed: you decide to play fast or not...
+Notes:
+ - Games start with a random assymetric position!
+ - No ratings, no tournaments: no "competition spirit"
## Resources
Server side:
- node,
- - npm packages (see package.json),
+ - Express,
+ - Other npm packages (see package.json),
Client side:
- Vue.js,
- - underscore.js (TODO: remove this dependency),
+ - underscore.js,
- mini.css,
- Google font 'Open Sans' + a few icons,
-Pieces images where found at various locations.
+Sounds and pieces images where found at various locations.
## Installation (for developers)
0. Install git-fat https://github.com/jedbrown/git-fat
- 1. Rename public/javascripts/utils/socket\_url.js.dist into socket\_url.js
- and adjust its content.
- 2. git fat init && git fat pull
- 3. Execute db/create.sql script (SQLite) to fill db/vchess.sqlite database
- 4. npm i && npm start
+ 1. git fat init && git fat pull
+ 2. Execute db/\*.sql scripts to create and fill db/vchess.sqlite
+ 3. Rename and edit public/javascripts/socket\_url.js.dist into socket\_url.js
+ 4. Rename and edit utils/mailer.js.dist into mailer.js
+ 5. npm i && npm start
+
+## Get involved
+
+All contributions are welcome! For example,
+ - translations,
+ - design,
+ - Vue front-end,
+ - Express back-end.
+
+If you wanna help, you can contact me with the form on the website,
+so that we can discuss what to do and how :)
+If you feel comfortable with the code a pull request is a good start too.
projects / vchess.git / blobdiff