|
1 |
| -#A17 Generator |
| 1 | +# A17 Generator |
2 | 2 |
|
3 |
| -A17 Generator is used to quickly install A17 FE libraries. |
| 3 | +A17 Generator is used to quickly install A17 FE libraries. It can: |
4 | 4 |
|
| 5 | +* generate a `package.json` for you, |
| 6 | +* initialise Git, |
| 7 | +* set up a Webpack build process, |
| 8 | +* add helpful dot files, |
| 9 | +* set up linting, |
| 10 | +* set up a pre-commit hook, |
| 11 | +* generate a `frontend` folder structure, |
| 12 | +* generate a `README.md`, |
| 13 | +* install a pattern library, |
5 | 14 |
|
6 |
| -## Usage |
7 |
| - |
8 |
| -**Install A17 Generator globally** |
9 |
| - |
10 |
| - ```shell |
11 |
| - $ npx @area17/a17-generator |
12 |
| - ``` |
13 |
| - |
14 |
| -**Go to the root of your project** |
15 |
| - |
16 |
| - ```shell |
17 |
| - $ cd project-root |
18 |
| - ``` |
19 |
| - |
20 |
| -**Initialize the A17 Boilerplate** |
21 |
| - |
22 |
| - ```shell |
23 |
| - # @ ~/project-root |
24 |
| - $ a17-generator [project-name] |
25 |
| - ``` |
| 15 | +Plus, it has ASCII art. |
26 | 16 |
|
| 17 | +## Usage |
27 | 18 |
|
28 |
| -Local build testing |
| 19 | +Firstly, you'll want to `cd` into a project folder if it already exists, or if not: |
29 | 20 |
|
30 | 21 | ```shell
|
31 |
| -$ rm -rf * & rm -rf *.* & rm -rf .* & node ../a17-generator/bin/a17_generator.js |
| 22 | +$ mkdir project-name && cd project-name |
32 | 23 | ```
|
33 | 24 |
|
34 |
| -## Change Log |
35 |
| - |
36 |
| -**1.0.0** |
37 |
| - |
38 |
| -Re-write |
39 |
| - |
40 |
| -**0.1.16** |
41 |
| - |
42 |
| -Update to latest version of boilerplate and helpers |
43 |
| - |
44 |
| -**0.1.15** |
45 |
| - |
46 |
| -Update to latest version of boilerplate |
47 |
| - |
48 |
| -**0.1.14** |
49 |
| - |
50 |
| -Update to latest version of boilerplate |
51 |
| - |
52 |
| -**0.1.13** |
53 |
| - |
54 |
| -Update to latest version of boilerplate |
55 |
| - |
56 |
| -**0.1.12** |
57 |
| - |
58 |
| -Update to latest version of boilerplate |
59 |
| - |
60 |
| -**0.1.11** |
61 |
| - |
62 |
| -Update to latest version of boilerplate |
| 25 | +And then run `a17-generator`; |
63 | 26 |
|
64 |
| -**0.1.10** |
65 |
| - |
66 |
| -Update to latest version of node, npm, boilerplate and helpers |
67 |
| - |
68 |
| -**0.1.9** |
69 |
| - |
70 |
| -Readme updates |
71 |
| - |
72 |
| -**0.1.8** |
73 |
| - |
74 |
| -Update to latest version of boilerplate and helpers |
75 |
| - |
76 |
| -**0.1.7** |
77 |
| - |
78 |
| -Update to latest version of boilerplate |
79 |
| - |
80 |
| -**0.1.6** |
81 |
| - |
82 |
| -Update to latest version of boilerplate |
83 |
| - |
84 |
| -**0.1.5** |
85 |
| - |
86 |
| -Update to latest version of boilerplate |
87 |
| - |
88 |
| -**0.1.4** |
89 |
| - |
90 |
| -Publish to npm |
91 |
| - |
92 |
| -**0.1.3** |
93 |
| - |
94 |
| -Make install information more clear |
95 |
| - |
96 |
| -**0.1.2** |
97 |
| - |
98 |
| -Add engines property to package.json |
99 |
| - |
100 |
| -**0.1.1** |
101 |
| - |
102 |
| -Updated default git packages link |
103 |
| - |
104 |
| -**0.1.0** |
| 27 | +```shell |
| 28 | +$ npx @area17/a17-generator |
| 29 | +``` |
105 | 30 |
|
106 |
| -The birth of A17 Generator |
| 31 | +You may be asked to install `a17-generator`. And then `a17-generator` will then ask you a series of questions and then begin installing and setting up as needed. |
0 commit comments