docs

react-declarative · Jan 15, 2022 · b0b7afd · b0b7afd
1 parent 7e8d373
commit b0b7afd
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -4,4 +4,40 @@
 
 ```bash
 npm install react-declarative
-```
+```
+
+## Declarative view builder
+
+A React form builder which interacts with a JSON endpoint to generate nested 12-column grids with input fields and automatic state management in a declarative style. Endpoint is typed by TypeScript guards (**IntelliSense** available). This tool is based on `material-ui` components, so your application will look beautiful on any device...
+
+## Screenshots
+
+### Breadcrumbs
+
+Form component for displaying row page which can be configured remotely
+
+![1.png](./docs/1.png)
+
+### List
+
+Basecrud list component which can be easily bond with [jsonapi endpoint](https://github.com/ppetzold/nestjs-paginate)
+
+![2.png](./docs/2.png)
+
+### One
+
+A declarative view builder. Can be used as a dashboard layout engine. Also configurable remotely
+
+![3.png](./docs/3.png)
+
+### Scaffold 
+
+Basic [AppBar](https://material.io/components/app-bars-top) plus [Drawer](https://material.io/components/navigation-drawer) component with nested groups of items and recursive search
+
+![4.png](./docs/4.png)
+
+### 5. Pickers
+
+Date, Time, One (custom json-templated form) pickers
+
+![5.png](./docs/5.png)
diff --git a/docs/1.png b/docs/1.png
diff --git a/docs/2.png b/docs/2.png
diff --git a/docs/3.png b/docs/3.png
diff --git a/docs/4.png b/docs/4.png
diff --git a/docs/5.png b/docs/5.png