Skip to content

Commit a71ee43

Browse files
committed
Switch to node14 and update documentation
1 parent 73428cf commit a71ee43

File tree

12 files changed

+310
-711
lines changed

12 files changed

+310
-711
lines changed

README.md

Lines changed: 164 additions & 95 deletions
Large diffs are not rendered by default.

packages/ant-component-mapper/README.md

Lines changed: 6 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,26 @@
44

55
[![Data Driven Form logo](images/logo.png)](https://data-driven-forms.org/)
66

7-
Material-UI component mapper for [Data Driven Forms](https://github.com/data-driven-forms/react-forms).
7+
Ant Design component mapper for [Data Driven Forms](https://github.com/data-driven-forms/react-forms).
88

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

1111
**Table of Contents**
1212

13+
- [More information](#more-information)
1314
- [Installation](#installation)
1415
- [React Form Renderer](#react-form-renderer)
1516
- [ANT mapper](#ant-mapper)
1617
- [Usage](#usage)
1718
- [Basic provided components](#basic-provided-components)
1819
- [Useful links](#useful-links)
19-
- [Development setup](#development-setup)
20-
- [Tests](#tests)
21-
- [Commits](#commits)
22-
- [Changes to documentation](#changes-to-documentation)
2320
- [Contribution](#contribution)
2421
- [LICENSE](#license)
2522

23+
### More information
24+
25+
For more information please check the root [repository](https://github.com/data-driven-forms/react-forms) or our [documentation page](https://data-driven-forms.org/).
26+
2627
### Installation
2728

2829
You need to add React Form Renderer
@@ -105,78 +106,6 @@ Data Driven Forms supports all kinds of component, basic set is consisted of:
105106
- [React Form Renderer](https://www.npmjs.com/package/@data-driven-forms/react-form-renderer)
106107
- [MaterialUI Mapper](https://www.npmjs.com/package/@data-driven-forms/ant-component-mapper)
107108

108-
109-
### Development setup
110-
111-
Data Driven Forms is a monorepo that uses [Lerna](https://github.com/lerna/lerna) and [yarn workspaces](https://classic.yarnpkg.com/blog/2017/08/02/introducing-workspaces/), so you can use all its commands as well.
112-
113-
1. Install
114-
115-
```console
116-
yarn install
117-
```
118-
119-
2. Build
120-
121-
```console
122-
yarn build
123-
```
124-
125-
3. Run a package
126-
127-
Each package has a small playground `package/demo`, where you can test your changes.
128-
129-
```console
130-
cd packages/ant-component-mapper
131-
yarn start
132-
```
133-
134-
4. How to clean?
135-
136-
```console
137-
rm yarn.lock
138-
yarn lerna clean # will delete all node_modules
139-
```
140-
141-
All packages are linked together by default, so if you run a `yarn build` in a package, all other packages are updated to the latest version of that package.
142-
143-
#### Tests
144-
145-
Tests can be ran from the core folder or from specific packages.
146-
147-
```console
148-
yarn test
149-
150-
yarn test packages/ant-component-mapper
151-
```
152-
153-
#### Commits
154-
155-
Data Driven Forms uses [Semantic Release](https://github.com/semantic-release/commit-analyzer)
156-
157-
Format:
158-
159-
```
160-
[type]([package]): message
161-
162-
fix(ant): title accepts node
163-
```
164-
165-
Types:
166-
- `feat`: a new feature, will trigger new `_.X._` release
167-
- `fix`: a fix, will trigger new `_._.X` release
168-
169-
Packages:
170-
- Please describe which package is being changed `pf3`, `renderer`, ...
171-
172-
Please, do not use Semantic Release, if you update only the demo.
173-
174-
All packages are releasing together and they share the version number.
175-
176-
#### Changes to documentation
177-
178-
If your changes influence API or add new features, you should describe these new options in the `demo` repository. Thanks!
179-
180109
### Contribution
181110

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

packages/blueprint-component-mapper/README.md

Lines changed: 5 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,20 @@ Blueprint component mapper for [Data Driven Forms](https://github.com/data-drive
1010

1111
**Table of Contents**
1212

13+
- [More information](#more-information)
1314
- [Installation](#installation)
1415
- [React Form Renderer](#react-form-renderer)
1516
- [Blueprint Mapper](#blueprint-mapper)
1617
- [Usage](#usage)
1718
- [Basic provided components](#basic-provided-components)
1819
- [Useful links](#useful-links)
19-
- [Development setup](#development-setup)
20-
- [Tests](#tests)
21-
- [Commits](#commits)
22-
- [Changes to documentation](#changes-to-documentation)
2320
- [Contribution](#contribution)
2421
- [LICENSE](#license)
2522

23+
### More information
24+
25+
For more information please check the root [repository](https://github.com/data-driven-forms/react-forms) or our [documentation page](https://data-driven-forms.org/).
26+
2627
### Installation
2728

2829
You need to add React Form Renderer
@@ -103,77 +104,6 @@ Data Driven Forms supports all kinds of component, basic set is consisted of:
103104
- [React Form Renderer](https://www.npmjs.com/package/@data-driven-forms/react-form-renderer)
104105
- [Blueprint 4 Mapper](https://www.npmjs.com/package/@data-driven-forms/blueprint-component-mapper)
105106

106-
107-
### Development setup
108-
109-
Data Driven Forms is a monorepo that uses [Lerna](https://github.com/lerna/lerna) and [yarn workspaces](https://classic.yarnpkg.com/blog/2017/08/02/introducing-workspaces/), so you can use all its commands as well.
110-
111-
1. Install
112-
113-
```console
114-
yarn install
115-
```
116-
117-
2. Build
118-
119-
```console
120-
yarn build
121-
```
122-
123-
3. Run a package
124-
125-
Each package has a small playground `package/demo`, where you can test your changes.
126-
127-
```console
128-
cd packages/blueprint-component-mapper
129-
yarn start
130-
```
131-
132-
4. How to clean?
133-
134-
```console
135-
yarn lerna clean # will delete all node_modules
136-
```
137-
138-
All packages are linked together by default, so if you run a `yarn build` in a package, all other packages are updated to the latest version of that package.
139-
140-
#### Tests
141-
142-
Tests can be ran from the core folder or from specific packages.
143-
144-
```console
145-
yarn test
146-
147-
yarn test packages/blueprint-component-mapper
148-
```
149-
150-
#### Commits
151-
152-
Data Driven Forms uses [Semantic Release](https://github.com/semantic-release/commit-analyzer)
153-
154-
Format:
155-
156-
```
157-
[type]([package]): message
158-
159-
fix(blueprint): title accepts node
160-
```
161-
162-
Types:
163-
- `feat`: a new feature, will trigger new `_.X._` release
164-
- `fix`: a fix, will trigger new `_._.X` release
165-
166-
Packages:
167-
- Please describe which package is being changed `pf3`, `renderer`, ...
168-
169-
Please, do not use Semantic Release, if you update only the demo.
170-
171-
All packages are releasing together and they share the version number.
172-
173-
#### Changes to documentation
174-
175-
If your changes influence API or add new features, you should describe these new options in the `react-renderer-demo` repository. Thanks!
176-
177107
### Contribution
178108

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

packages/carbon-component-mapper/README.md

Lines changed: 5 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,20 @@ Carbon component mapper for [Data Driven Forms](https://github.com/data-driven-f
1010

1111
**Table of Contents**
1212

13+
- [More information](#more-information)
1314
- [Installation](#installation)
1415
- [React Form Renderer](#react-form-renderer)
1516
- [Carbon Mapper](#carbon-mapper)
1617
- [Usage](#usage)
1718
- [Basic provided components](#basic-provided-components)
1819
- [Useful links](#useful-links)
19-
- [Development setup](#development-setup)
20-
- [Tests](#tests)
21-
- [Commits](#commits)
22-
- [Changes to documentation](#changes-to-documentation)
2320
- [Contribution](#contribution)
2421
- [LICENSE](#license)
2522

23+
### More information
24+
25+
For more information please check the root [repository](https://github.com/data-driven-forms/react-forms) or our [documentation page](https://data-driven-forms.org/).
26+
2627
### Installation
2728

2829
You need to add React Form Renderer
@@ -103,76 +104,6 @@ Data Driven Forms supports all kinds of component, basic set is consisted of:
103104
- [Carbon Design System documentation](https://www.carbondesignsystem.com/)
104105
- [Carbon React Compononents storybook](https://react.carbondesignsystem.com/)
105106

106-
### Development setup
107-
108-
Data Driven Forms is a monorepo that uses [Lerna](https://github.com/lerna/lerna) and [yarn workspaces](https://classic.yarnpkg.com/blog/2017/08/02/introducing-workspaces/), so you can use all its commands as well.
109-
110-
1. Install
111-
112-
```console
113-
yarn install
114-
```
115-
116-
2. Build
117-
118-
```console
119-
yarn build
120-
```
121-
122-
3. Run a package
123-
124-
Each package has a small playground `package/demo`, where you can test your changes.
125-
126-
```console
127-
cd packages/carbon-component-mapper
128-
yarn start
129-
```
130-
131-
4. How to clean?
132-
133-
```console
134-
yarn lerna clean # will delete all node_modules
135-
```
136-
137-
All packages are linked together by default, so if you run a `yarn build` in a package, all other packages are updated to the latest version of that package.
138-
139-
#### Tests
140-
141-
Tests can be ran from the core folder or from specific packages.
142-
143-
```console
144-
yarn test
145-
146-
yarn test packages/carbon-component-mapper
147-
```
148-
149-
#### Commits
150-
151-
Data Driven Forms uses [Semantic Release](https://github.com/semantic-release/commit-analyzer)
152-
153-
Format:
154-
155-
```
156-
[type]([package]): message
157-
158-
fix(carbon): title accepts node
159-
```
160-
161-
Types:
162-
- `feat`: a new feature, will trigger new `_.X._` release
163-
- `fix`: a fix, will trigger new `_._.X` release
164-
165-
Packages:
166-
- Please describe which package is being changed `carbon`, `renderer`, ...
167-
168-
Please, do not use Semantic Release, if you update only the demo.
169-
170-
All packages are releasing together and they share the version number.
171-
172-
#### Changes to documentation
173-
174-
If your changes influence API or add new features, you should describe these new options in the `react-renderer-demo` repository. Thanks!
175-
176107
### Contribution
177108

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

packages/common/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
This package exists to share code used by more than one data-driven-forms package, such as:
66

77
- shared interfaces - propTypes
8-
- common mappers code
8+
- common mappers code
99
- wizard
1010
- select
1111
- multiplechoice list
@@ -15,12 +15,13 @@ This package exists to share code used by more than one data-driven-forms packag
1515

1616
...and some boring config files etc.
1717

18-
19-
This packages is not released but can be referenced in mapper packages. Demo packages does not have access to common package!
20-
2118
## Usage
2219
2320
```
2421
import demoSchema from '../../../shared/demoschema';
2522
2623
```
24+
25+
# More information
26+
27+
For more information please check the root [repository](https://github.com/data-driven-forms/react-forms) or our [documentation page](https://data-driven-forms.org/).

0 commit comments

Comments
 (0)