projects / vchess.git / blame
| Commit | Line | Data |
|---|---|---|
| 1d184b4c BA |
1 | # v[ariant]chess.club |
| 2 | ||
| 263eef68 BA |
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. | |
| 1d184b4c | 6 | |
| 8d7e2786 | 7 | Notes: |
| b6487fb9 | 8 | - Games start with a random assymetric position! |
| 8d7e2786 | 9 | - No ratings, no tournaments: no "competition spirit" |
| 1d184b4c BA |
10 | |
| 11 | ## Resources | |
| 12 | ||
| 13 | Server side: | |
| ae99d72c | 14 | - Node.js, |
| 8d7e2786 BA |
15 | - Express, |
| 16 | - Other npm packages (see package.json), | |
| 1d184b4c BA |
17 | |
| 18 | Client side: | |
| 19 | - Vue.js, | |
| ae99d72c | 20 | - Underscore.js, |
| 1d184b4c BA |
21 | - mini.css, |
| 22 | - Google font 'Open Sans' + a few icons, | |
| 23 | ||
| 25ee5469 | 24 | Sounds and pieces images where found at various locations. |
| 1d184b4c BA |
25 | |
| 26 | ## Installation (for developers) | |
| 27 | ||
| 28 | 0. Install git-fat https://github.com/jedbrown/git-fat | |
| a48ee8b8 | 29 | 1. git fat init && git fat pull |
| c326e657 BA |
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 | |
| ae99d72c | 32 | 4. Rename and edit config/parameters.js.dist into parameters.js |
| 8d7e2786 | 33 | 5. npm i && npm start |
| 263eef68 BA |
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 | ||
| 8d7e2786 BA |
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 :) | |
| 263eef68 | 45 | If you feel comfortable with the code a pull request is a good start too. |