From a587216a3e1b56f20da1ab098dcb68f579a53874 Mon Sep 17 00:00:00 2001 From: Stefan Dirix Date: Wed, 7 Aug 2024 13:21:41 +0200 Subject: [PATCH] chore: align scripts and update docs Aligns the scripts with the published documentation. Also updates the root Readme. --- README.md | 5 +---- package.json | 3 ++- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 42eb6ae..6620e20 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,7 @@ 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. -It is based on `create-react-app` and only contains minor modifications. - - Execute `npm ci` to install the prerequisites. If you want to have the latest released versions use `npm install`. -- Execute `npm run build` to build the application. - Execute `npm start` to start the application. 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 ## Rendering JSON Forms -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. +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. ## Custom renderers diff --git a/package.json b/package.json index 0ed83b0..cd739f4 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ "build": "tsc && vite build", "format": "prettier --write \"**/*.{ts,tsx,md,css,scss}\"", "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0", - "start": "vite preview --port 3000", + "preview": "vite preview --port 3000", + "start": "vite --port 3000", "test": "vitest run --coverage", "cypress:open": "cypress open", "cypress:run": "cypress run --config video=false",