Skip to content

Commit 12512a5

Browse files
committed
Update repo demo readme for nextjs
1 parent fac3fc5 commit 12512a5

File tree

1 file changed

+8
-40
lines changed
  • packages/react-renderer-demo/src/app

1 file changed

+8
-40
lines changed

packages/react-renderer-demo/src/app/README.md

Lines changed: 8 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
[![Data Driven Form logo](images/logo.png)](https://data-driven-forms.org/)
1+
[![Data Driven Form logo](https://raw.githubusercontent.com/data-driven-forms/react-forms/master/images/logo.png)](https://data-driven-forms.org/)
22

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/).
44

55
:book: For more information please visit the [documentation](https://data-driven-forms.org/). :book:
66

@@ -11,38 +11,35 @@ Used by [ManageIQ](http://manageiq.org/), Red Hat Cloud Services.
1111
- [Development setup](#development-setup)
1212
- [Tests](#tests)
1313
- [Commits](#commits)
14-
- [Changes to documentation](#changes-to-documentation)
1514
- [Contribution](#contribution)
1615
- [LICENSE](#license)
1716

1817
### Development setup
1918

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-
2219
1. Install
2320

2421
```console
22+
cd ../..
2523
yarn install
2624
```
2725

2826
2. Build
2927

3028
```console
29+
cd ../..
3130
yarn build
3231
```
3332

3433
3. Run a package
3534

36-
Each package has a small playground `package/demo`, where you can test your changes.
37-
3835
```console
39-
cd packages/react-renderer-demo
40-
yarn start
36+
yarn dev
4137
```
4238

43-
4. How to clean?
39+
1. How to clean?
4440

4541
```console
42+
cd ../..
4643
rm yarn.lock
4744
yarn lerna clean # will delete all node_modules
4845
```
@@ -51,41 +48,12 @@ All packages are linked together by default, so if you run a `yarn build` in a p
5148

5249
#### Tests
5350

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.
6152

6253
#### Commits
6354

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-
8155
Please, do not use Semantic Release, if you update only the demo.
8256

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-
8957
### Contribution
9058

9159
We welcome any community contribution. Don't be afraid to report bug or to create issues and pull-requests! :trophy:

0 commit comments

Comments
 (0)