[vchess.git] / README.md

# 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.

## 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...

## Resources

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

Client side:
 - Vue.js,
 - underscore.js (TODO: remove this dependency),
 - mini.css,
 - Google font 'Open Sans' + a few icons,

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
Commit	Line	Data
	1	# v[ariant]chess.club
	2
	3	Website to play to many chess variants, including rare ones - some almost never seens
	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
	14	## Resources
	15
	16	Server side:
	17	- node,
	18	- npm packages (see package.json),
	19
	20	Client side:
	21	- Vue.js,
	22	- underscore.js (TODO: remove this dependency),
	23	- mini.css,
	24	- Google font 'Open Sans' + a few icons,
	25
	26	Pieces images where found at various locations.
	27
	28	## Installation (for developers)
	29
	30	0. Install git-fat https://github.com/jedbrown/git-fat
	31	1. Rename public/javascripts/utils/socket\_url.js.dist into socket\_url.js
	32	and adjust its content.
	33	2. git fat init && git fat pull
	34	3. Execute db/create.sql script (SQLite) to fill db/vchess.sqlite database
	35	4. npm i && npm start