Skip to content

docs(demo/readme): add a readme file for demo app #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fffjacquier wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(demo/readme): add a readme file for demo app #70

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions apps/demo/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<h1 align="center">Demo app 👋</h1>

<h2>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</h2>

### 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
Comment on lines +14 to +15
Copy link
Collaborator

@hpierre74 hpierre74 Mar 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we shouldn't provide paths and file names, it may change

You can find 3 links in the navigation top bar.

#### Link Styled Components

This page doesn't use any UI library.
Copy link
Collaborator

@hpierre74 hpierre74 Mar 10, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one could argue styled-components IS a 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