From f8d483e3fc53da253aec24ce7bd3bb376d1d30f4 Mon Sep 17 00:00:00 2001 From: fffjacquier Date: Fri, 4 Mar 2022 15:32:52 +0100 Subject: [PATCH] docs(demo/readme): add a readme file for demo app --- apps/demo/README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 apps/demo/README.md diff --git a/apps/demo/README.md b/apps/demo/README.md new file mode 100644 index 0000000..eb84219 --- /dev/null +++ b/apps/demo/README.md @@ -0,0 +1,34 @@ +

Demo app 👋

+ +

The purpose of this demo app is to show one way of using the following libraries: form-builder, form-editor, form-context, form-redux, form-validation-rule-list

+ +### How to start the demo + +`yarn start demo` + +### Current demo features + +The default page / shows a Register Form with redux using Material UI. + +You can have two different from config available right now: +- a register.config.ts in src/app +- a login.config.ts in src/app +You can find 3 links in the navigation top bar. + +#### Link Styled Components + +This page doesn't use any UI library. +It's a multi-step register form component done with Styled Components. +It uses the register.config.ts to work. + +#### Link Material UI + +This page uses Material UI system and shows: +- a register form using React Redux +- a login form using React Context API + +#### Link Schema Builder + +This page allows you +- to upload existing scheme or dictionary or extra-validation objects. +- to generate your form schema by adding steps and fields with all the necessary parameters