Update TODO + 'simplify' download_objects script
[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
9Finally install dependencies.
625022fd
BA
10```
11npm install
12```
13
14### Compiles and hot-reloads for development
68ff3913 15
625022fd
BA
16```
17npm run serve
18```
19
20### Compiles and minifies for production
68ff3913 21
625022fd
BA
22```
23npm run build
24```
25
26### Lints and fixes files
68ff3913 27
625022fd
BA
28```
29npm run lint
30```
31
32### Customize configuration
68ff3913 33
625022fd
BA
34See [Configuration Reference](https://cli.vuejs.org/config/).
35
36## Resources
37
d54f6261
BA
38- Vue.js + Vue router,
39- Webpack,
40- mini.css
625022fd
BA
41
42Sounds and pieces images where found at various locations.
d54f6261 43Fonts were found on Google Fonts.