File tree 2 files changed +36
-0
lines changed
2 files changed +36
-0
lines changed Original file line number Diff line number Diff line change 1
1
# Summary
2
2
3
3
* [ Read Me] ( /README.md )
4
+
5
+ * [ Development] ( dev/README.md )
6
+
4
7
* [ Styles] ( styles/README.md )
5
8
* [ Using CSS Classes] ( styles/classes.md )
6
9
* [ Overriding Defaults] ( styles/defaults.md )
Original file line number Diff line number Diff line change
1
+ # Development
2
+
3
+ ` react-modal ` uses ` make ` to build and publish new versions and documentation.
4
+
5
+ It works as a checklist for the future releases to keep everything updated such as
6
+ ` CHANGELOG.md ` , ` package.json ` and ` bower.json ` and so on.
7
+
8
+ The minimun works as a normal ` npm script ` .
9
+
10
+ ## Usage
11
+
12
+ Once you clone ` react-modal ` , you can run ` sh bootstrap.sh ` to check
13
+ and download dependencies not managed by ` react-modal ` such as ` gitbook-cli ` .
14
+
15
+ It will also show information about the current versions of ` node ` , ` npm ` ,
16
+ ` yarn ` and ` jq ` available.
17
+
18
+ ## List of ` npm ` commands:
19
+
20
+ $ npm start -s or yarn start # to run examples
21
+ $ npm run tests
22
+ $ npm run lint
23
+
24
+ ## List of ` make ` commands:
25
+
26
+ $ make help # show all make commands available
27
+ $ make deps # npm install, gitbook plugins...
28
+ $ make serve # to run examples
29
+ $ make tests # use when developing
30
+ $ make tests-ci # single run
31
+ $ make lint # pass lint
32
+ $ make publish # execute the entire pipeline to publish
33
+ $ make publish-docs # execute the pipeline for docs
You can’t perform that action at this time.
0 commit comments