Skip to content

Robust JavaScript library for creating CRUD interfaces and services

License

Notifications You must be signed in to change notification settings

DeReCRUD/de-re-crud

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

De Re CRUD

GitHub License Build codecov

For more information about the ideology of library, see this.

Getting Started

Install preact, core, and UI libraries:

yarn add preact@next  #or npm install --save preact@next
yarn add @de-re-crud/core #or npm install --save @de-re-crud/core 
yarn add @de-re-crud/ui #or npm install --save @de-re-crud/ui 

Install a theme:

# You will need to include Bootstrap 4 CSS.
yarn add @de-re-crud/theme-bootstrap4 #or npm install --save @de-re-crud/theme-bootstrap4

Import the neccessary exports and render the form:

import { h, Form } from '@de-re-crud/ui'; // h is re-exported from preact for convenience
import { Bootstrap4RendererOptions } from '@de-re-crud/theme-bootstrap4';
import schemaJson from './schema.json'; // Your defined De Re CRUD schema

h(
  <Form
    rendererOptions={Bootstrap4RendererOptions}
    schema={schemaJson}
    struct="struct"
    onSubmit={() => {
        // Handle submission
    }}
  />,
  document.getElementById('root') // An element in the body
);

Examples

Roadmap

  • Improve documentation
  • Improve test coverage
  • React support
  • React Native support
  • Vue support
  • Schema builder
  • Support for the R and D in CRUD
  • Backend service and database support

About

Robust JavaScript library for creating CRUD interfaces and services

Resources

License

Stars

Watchers

Forks

Packages

No packages published