[vchess.git] / README.md

# v[ariant]chess.club

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...
 - Your identity (if filled) is revealed only after the game

## Resources

Server side:
 - node,
 - npm packages (see package.json),

Client side:
 - Vue.js,
 - underscore.js,
 - mini.css,
 - Google font 'Open Sans' + a few icons,

Sounds and pieces images where found at various locations.

## Installation (for developers)

 0. Install git-fat https://github.com/jedbrown/git-fat
 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. npm i && npm start
Commit	Line	Data
	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/\*.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