1111
1212## Installation
1313
14- We assume that you already have installed:
14+ ##### Prerequisites
1515
1616- [ ` yarn ` ] ( https://yarnpkg.com/ ) _ - it's our default package manager_
1717- [ ` yeoman ` ] ( https://yeoman.io/ ) (` yarn global add yo ` )
1818
19- Then you can install this generator:
19+ ##### Installation command
2020
2121```
2222yarn global add generator-codibly-ts
@@ -29,6 +29,46 @@ And that's it - you are ready to generate ✨
2929To generate something use ` yo codibly-ts ` command - it will guide you through the
3030generation process.
3131
32+ There four types of frames you can generate
33+
34+ - ** Structure** creates choosen part of an app structure according to Codibly guidelines
35+ - ** Library**
36+ - ** Application**
37+ - ** Configuration**
38+
39+ ## Structure🚧🚧💅
40+
41+ To generate part of an app structure according to Codibly guidelines run ` yo codibly-ts:strucutre ` .
42+
43+ You will be asked to choose one of four parts of the structure
44+
45+ - ** Module** creates structure for business model - generates ** API** and ** Model** structures under given ** Module** name
46+ - ** API** creates ` APIStrucutre ` with given structure name
47+ - ** Component** creates ` ComponentStrucutre ` with given structure name
48+ - ** Model** creates ` ModelStrucutre ` with given structure name🚧
49+ - ** Store** under construction
50+
51+ ## Config
52+
53+ You can customize the generator output by creating ` .yo-rc.json ` file in your project. and setting up its values.
54+
55+ Important thing is to put ` "generator-codibly-ts" ` field into this file.
56+ Under this key you can put the following fields:
57+
58+ | field | value |
59+ | ------- | ------------------------------------------------- |
60+ | styling | "jss" | ; "styled-components" | ; "emotion" |
61+
62+ Example config
63+
64+ ```
65+ {
66+ "generator-codibly-ts": {
67+ "styling": "emotion"
68+ }
69+ }
70+ ```
71+
3272## License
3373
3474MIT
0 commit comments