Skip to content

Commit a587216

Browse files
committed
chore: align scripts and update docs
Aligns the scripts with the published documentation. Also updates the root Readme.
1 parent 0cf46f8 commit a587216

File tree

2 files changed

+3
-5
lines changed

2 files changed

+3
-5
lines changed

README.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,7 @@
22

33
This seed demonstrates how to use [JSON Forms](https://jsonforms.io) with React in order to render a simple form for displaying a task entity.
44

5-
It is based on `create-react-app` and only contains minor modifications.
6-
75
- Execute `npm ci` to install the prerequisites. If you want to have the latest released versions use `npm install`.
8-
- Execute `npm run build` to build the application.
96
- Execute `npm start` to start the application.
107

118
Browse to http://localhost:3000 to see the application in action.
@@ -25,7 +22,7 @@ The [corresponding UI schema](src/uischema.json) specifies controls for each pro
2522

2623
## Rendering JSON Forms
2724

28-
JSON Forms is rendered by importing and using the `JsonForms` component and directly handing over the `schema`, `uischema`, `data`, `renderer` and `cell` props. We listen to changes in the form via the `onChange` callback.
25+
JSON Forms is rendered by importing and using the `JsonForms` component and directly handing over the `schema`, `uischema`, `data`, `renderers` and `cells` props. We listen to changes in the form via the `onChange` callback.
2926

3027
## Custom renderers
3128

package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@
3838
"build": "tsc && vite build",
3939
"format": "prettier --write \"**/*.{ts,tsx,md,css,scss}\"",
4040
"lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
41-
"start": "vite preview --port 3000",
41+
"preview": "vite preview --port 3000",
42+
"start": "vite --port 3000",
4243
"test": "vitest run --coverage",
4344
"cypress:open": "cypress open",
4445
"cypress:run": "cypress run --config video=false",

0 commit comments

Comments
 (0)