1 | Contributing
|
2 | ============
|
3 |
|
4 | ## Construction
|
5 |
|
6 | ## Scripts
|
7 |
|
8 | ### Dev Server
|
9 |
|
10 | ```shell
|
11 | $ gulp
|
12 | ```
|
13 |
|
14 | Start a development server, pages below would be activated (file changes will trigger building automatically).
|
15 |
|
16 | * Homepage: http://127.0.0.1:2047/
|
17 | * Tests: http://127.0.0.1:2047/spec/
|
18 |
|
19 | ### Building(Packing)
|
20 |
|
21 | ```shell
|
22 | $ gulp pack
|
23 | ```
|
24 |
|
25 | Packing, generates products into directory `/dist`.
|
26 |
|
27 | ### Linting
|
28 |
|
29 | ```shell
|
30 | $ gulp lint
|
31 | # equals gulp eslint && gulp htmlhint
|
32 | ```
|
33 |
|
34 | Linting.
|
35 |
|
36 | ### Templates
|
37 |
|
38 | ```shell
|
39 | $ gulp template2module
|
40 | ```
|
41 |
|
42 | Converting templates (`/src/template/*` and `/lib/template/*`) into js modules.
|
43 |
|
44 | ### Others
|
45 |
|
46 | * `$ gulp commonjs2es6` (be careful)
|
47 | * `$ gulp jsdoc`
|
48 | * `$ gulp svg-sprite` (not ready yet)
|