Skip to content

Commit 7b1e190

Browse files
committed
Update readme to include all commands
1 parent c6b2c05 commit 7b1e190

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@
77
- [Available Scripts](#available-scripts)
88
- [`npm install`](#npm-install)
99
- [`npm bootstrap`](#npm-bootstrap)
10+
- [`npm run test`](#npm-run-test)
11+
- [`npm run build`](#npm-run-build)
12+
- [`npm run clean-build`](#npm-run-clean-build)
13+
- [`npm run lint`](#npm-run-lint)
14+
- [`npm run integration:tests`](#npm-run-integrationtests)
15+
- [`npm run start`](#npm-run-start)
16+
- [Release](#release)
1017

1118
:warning: **THIS IS WIP REPOSITORY!** :warning:
1219
# Data Driven Forms Pro Editor
@@ -48,5 +55,43 @@ In the project directory, you can run:
4855

4956
## `npm install`
5057

58+
to install dependencies
5159
## `npm bootstrap`
5260

61+
to bootstrap packages (to link them)
62+
63+
## `npm run test`
64+
65+
to run JEST test
66+
67+
## `npm run build`
68+
69+
to build all packages
70+
71+
## `npm run clean-build`
72+
73+
removes built folders (runs automatically before `install`)
74+
75+
## `npm run lint`
76+
77+
to check linting rules (use `npm run lint:fix` to fix basic issues)
78+
79+
## `npm run integration:tests`
80+
81+
to run integration test for the editor-pro
82+
83+
---
84+
85+
In each package directory you can run:
86+
87+
## `npm run start`
88+
89+
to run a local playground
90+
91+
# Release
92+
93+
Data Driven Forms editor follows semantic release to trigger new versions automatically.
94+
95+
You can use: `fix(...): ...`, `feat(...): ...` commit messages to release new packages.
96+
97+
Packages are handled seperately.

0 commit comments

Comments
 (0)