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