[vchess.git] / client / README.md

# vchess-client

## Project setup

Rename and edit src/parameters.js.dist into parameters.js. Then,
download the folders and files listed in download\_objects file.
(This is optional, most variants will work without it).

For Emergo and Avalam, run generateSVG\*.py scripts in folder
public/images/pieces/Emergo and Avalam (pieces SVGs).

Finally install dependencies.
```
npm install
```

### Compiles and hot-reloads for development

```
npm run serve
```

### Compiles and minifies for production

```
npm run build
```

### Lints and fixes files

```
npm run lint
```

### Customize configuration

See [Configuration Reference](https://cli.vuejs.org/config/).

## Resources

- Vue.js + Vue router,
- Webpack,
- mini.css

Sounds and pieces images where found at various locations.
Fonts were found on Google Fonts.
Commit	Line	Data
	1	# vchess-client
	2
	3	## Project setup
	4
	5	Rename and edit src/parameters.js.dist into parameters.js. Then,
	6	download the folders and files listed in download\_objects file.
	7	(This is optional, most variants will work without it).
	8
	9	For Emergo and Avalam, run generateSVG\*.py scripts in folder
	10	public/images/pieces/Emergo and Avalam (pieces SVGs).
	11
	12	Finally install dependencies.
	13	```
	14	npm install
	15	```
	16
	17	### Compiles and hot-reloads for development
	18
	19	```
	20	npm run serve
	21	```
	22
	23	### Compiles and minifies for production
	24
	25	```
	26	npm run build
	27	```
	28
	29	### Lints and fixes files
	30
	31	```
	32	npm run lint
	33	```
	34
	35	### Customize configuration
	36
	37	See [Configuration Reference](https://cli.vuejs.org/config/).
	38
	39	## Resources
	40
	41	- Vue.js + Vue router,
	42	- Webpack,
	43	- mini.css
	44
	45	Sounds and pieces images where found at various locations.
	46	Fonts were found on Google Fonts.