You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/react-renderer-demo/src/app/README.md
+8-40Lines changed: 8 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
[](https://data-driven-forms.org/)
1
+
[](https://data-driven-forms.org/)
2
2
3
-
A documentation page for [Data Driven Forms](https://github.com/data-driven-forms/react-forms).
3
+
A documentation page for [Data Driven Forms](https://github.com/data-driven-forms/react-forms). A server-side application based on [NextJS](https://nextjs.org/).
4
4
5
5
:book: For more information please visit the [documentation](https://data-driven-forms.org/). :book:
6
6
@@ -11,38 +11,35 @@ Used by [ManageIQ](http://manageiq.org/), Red Hat Cloud Services.
11
11
-[Development setup](#development-setup)
12
12
-[Tests](#tests)
13
13
-[Commits](#commits)
14
-
-[Changes to documentation](#changes-to-documentation)
15
14
-[Contribution](#contribution)
16
15
-[LICENSE](#license)
17
16
18
17
### Development setup
19
18
20
-
Data Driven Forms is a monorepo which uses [Lerna](https://github.com/lerna/lerna), so you can use all its commands as well.
21
-
22
19
1. Install
23
20
24
21
```console
22
+
cd ../..
25
23
yarn install
26
24
```
27
25
28
26
2. Build
29
27
30
28
```console
29
+
cd ../..
31
30
yarn build
32
31
```
33
32
34
33
3. Run a package
35
34
36
-
Each package has a small playground `package/demo`, where you can test your changes.
37
-
38
35
```console
39
-
cd packages/react-renderer-demo
40
-
yarn start
36
+
yarn dev
41
37
```
42
38
43
-
4. How to clean?
39
+
1. How to clean?
44
40
45
41
```console
42
+
cd ../..
46
43
rm yarn.lock
47
44
yarn lerna clean # will delete all node_modules
48
45
```
@@ -51,41 +48,12 @@ All packages are linked together by default, so if you run a `yarn build` in a p
51
48
52
49
#### Tests
53
50
54
-
Tests needed to be run from the core folder.
55
-
56
-
```console
57
-
yarn test
58
-
59
-
yarn test packages/pf3-component-mapper
60
-
```
51
+
Documentation does not contain any test files currently.
61
52
62
53
#### Commits
63
54
64
-
Data Driven Forms uses [Semantic Release](https://github.com/semantic-release/commit-analyzer)
65
-
66
-
Format:
67
-
68
-
```
69
-
[type]([package]): message
70
-
71
-
fix(pf3): title accepts node
72
-
```
73
-
74
-
Types:
75
-
-`feat`: a new feature, will trigger new `_.X._` release
76
-
-`fix`: a fix, will trigger new `_._.X` release
77
-
78
-
Packages:
79
-
- Please describe which package is being changed `pf3`, `renderer`, ...
80
-
81
55
Please, do not use Semantic Release, if you update only the demo.
82
56
83
-
All packages are releasing together and they share the version number.
84
-
85
-
#### Changes to documentation
86
-
87
-
If your changes influence API or add new features, you should describe these new options in the `demo` repository. Thanks!
88
-
89
57
### Contribution
90
58
91
59
We welcome any community contribution. Don't be afraid to report bug or to create issues and pull-requests! :trophy:
0 commit comments