vn-kooch-react-admin

A frontend Framework for building admin applications running in the browser on top of REST/GraphQL services, using ES6, React and Material Design. Open sourced and maintained by marmelab.

Demo - Documentation - Releases - Support

Features

Adapts to any backend (REST, GraphQL, SOAP, etc.)
Complete documentation
Optimistic rendering (renders before the server returns)
Relationships (many to one, one to many)
Internationalization (i18n)
Conditional formatting
Themeable
Supports any authentication provider (REST API, OAuth, Basic Auth, ...)
Full-featured Datagrid (sort, pagination, filters)
Filter-as-you-type
Supports any form layout (simple, tabbed, etc.)
Data Validation
Custom actions
Large library of components for various data types: boolean, number, rich text, etc.
WYSIWYG editor
Customize dashboard, menu, layout
Super easy to extend and override (it's just React components)
Highly customizable interface
Can connect to multiple backends
Leverages the best libraries in the React ecosystem (Redux, redux-form, redux-saga, material-ui, recompose)
Can be included in another React app
Inspired by the popular ng-admin library (also by marmelab)

Versions In This Repository

master - commits that will be included in the next patch release
next - commits that will be included in the next major or minor release

Bugfix PRs that don't break BC should be made against master. All other PRs (new features, bugfix with BC break) should be made against next.

Installation

vn-kooch-react-admin is available from npm. You can install it (and its required dependencies) using:

npm install --save-dev vn-kooch-react-admin

Documentation

Read the Tutorial for a 15 minutes introduction. After that, head to the Documentation, or checkout the source code of the demo for an example usage.

At a Glance

// in app.js
import React from 'react';
import { render } from 'react-dom';
import { Admin, Resource } from 'vn-kooch-react-admin';
import restProvider from 'vn-kooch-data-simple-rest';

import { PostList, PostEdit, PostCreate, PostIcon } from './posts';

render(
    <Admin dataProvider={restProvider('http://localhost:3000')}>
        <Resource name="posts" list={PostList} edit={PostEdit} create={PostCreate} icon={PostIcon}/>
    </Admin>,
    document.getElementById('root')
);

The <Resource> component is a configuration component that allows to define sub components for each of the admin view: list, edit, and create. These components use Material UI and custom components from vn-kooch-react-admin:

// in posts.js
import React from 'react';
import { List, Datagrid, Edit, Create, SimpleForm, DateField, TextField, EditButton, DisabledInput, TextInput, LongTextInput, DateInput } from 'vn-kooch-react-admin';
export PostIcon from '@material-ui/core/svg-icons/action/book';

export const PostList = (props) => (
    <List {...props}>
        <Datagrid>
            <TextField source="id" />
            <TextField source="title" />
            <DateField source="published_at" />
            <TextField source="average_note" />
            <TextField source="views" />
            <EditButton basePath="/posts" />
        </Datagrid>
    </List>
);

const PostTitle = ({ record }) => {
    return <span>Post {record ? `"${record.title}"` : ''}</span>;
};

export const PostEdit = (props) => (
    <Edit title={<PostTitle />} {...props}>
        <SimpleForm>
            <DisabledInput source="id" />
            <TextInput source="title" />
            <TextInput source="teaser" options={{ multiLine: true }} />
            <LongTextInput source="body" />
            <DateInput label="Publication date" source="published_at" />
            <TextInput source="average_note" />
            <DisabledInput label="Nb views" source="views" />
        </SimpleForm>
    </Edit>
);

export const PostCreate = (props) => (
    <Create title="Create a Post" {...props}>
        <SimpleForm>
            <TextInput source="title" />
            <TextInput source="teaser" options={{ multiLine: true }} />
            <LongTextInput source="body" />
            <TextInput label="Publication date" source="published_at" />
            <TextInput source="average_note" />
        </SimpleForm>
    </Create>
);

Does It Work With My API?

Yes.

vn-kooch-react-admin uses an adapter approach, with a concept called Data Providers. Existing providers can be used as a blueprint to design your API, or you can write your own Data Provider to query an existing API. Writing a custom Data Provider is a matter of hours.

See the Data Providers documentation for details.

Batteries Included But Removable

vn-kooch-react-admin is designed as a library of loosely coupled React components built on top of material-ui, in addition to controller functions implemented the Redux way. It is very easy to replace one part of vn-kooch-react-admin with your own, e.g. to use a custom datagrid, GraphQL instead of REST, or bootstrap instead of Material Design.

Run the example

You can run the example app by calling:

npm install
make run

And then browse to http://localhost:8080/. The credentials are login/password

Contributing

Pull requests are welcome. You must follow the coding style of the existing files (based on prettier), and include unit tests and documentation. Be prepared for a thorough code review, and be patient for the merge - this is an open-source initiative.

You can run the tests (linting, unit and functional tests) by calling

make test

If you have coding standards problems, you can fix them automatically using prettier by calling

make prettier

If you want to contribute to the documentation, install jekyll, then call

make doc

And then browse to http://localhost:4000/

Note: if you have added a section with heading to the docs, you also have to add it to docs/_layouts/default.html (the links on the left) manually.

If you are using vn-kooch-react-admin as a dependency, and if you want to try and hack it, here is the advised process:

# in myapp
# install vn-kooch-react-admin from GitHub in another directory
$ cd ..
$ git clone git@github.com:marmelab/vn-kooch-react-admin.git && cd vn-kooch-react-admin && make install
# replace your node_modules/vn-kooch-react-admin by a symbolic link to the github checkout
$ cd ../myapp
$ npm link ../vn-kooch-react-admin
# go back to the checkout, and replace the version of react by the one in your app
$ cd ../vn-kooch-react-admin
$ npm link ../myapp/node_modules/react
$ make watch
# in another terminal, go back to your app, and start it as usual
$ cd ../myapp
$ npm run

Tip: If you're on Windows and can't use make, try this Gist.

License

vn-kooch-react-admin is licensed under the MIT License, sponsored and supported by marmelab.

Donate

This library is free to use, even for commercial purpose. If you want to give back, please talk about it, help newcomers, or contribute code. But the best way to give back is to donate to a charity. We recommend Doctors Without Borders.