gem-hunter
Language: TypeScript
A frontend Framework for single-page applications on top of REST/GraphQL APIs, using TypeScript, React and Material Design
A frontend Framework for building single-page applications running in the browser on top of REST/GraphQL APIs, using TypeScript, React and Material Design. Open sourced and maintained by marmelab.
Home page - Documentation - Examples - Blog - Releases - Support
🔌 Backend Agnostic: Connects to any API (REST or GraphQL, see the list of more than 45 adapters)
🧩 All The Building Blocks You Need: Provides hooks and components for authentication, routing, forms & validation, datagrid, search & filter, relationships, validation, roles & permissions, rich text editor, i18n, notifications, menus, theming, caching, etc.
🪡 High Quality: Accessibility, responsive, secure, fast, testable
💻 Great Developer Experience: Complete documentation, IDE autocompletion, type safety, storybook, demo apps with source code, modular architecture, declarative API
👑 Great User Experience: Optimistic rendering, filter-as-you-type, undo, preferences, saved queries
🛠 Complete Customization: Replace any component with your own
☂️ Opt-In Types: Develop either in TypeScript or JavaScript
👨👩👧👦 Powered by Material UI, react-hook-form, react-router, react-query, TypeScript and a few more
React-admin is available from npm. You can install it (and its required dependencies) using:
npm install react-admin
#or
yarn add react-admin// in app.js import * as React from "react"; import { createRoot } from 'react-dom/client'; import { Admin, Resource } from 'react-admin'; import restProvider from 'ra-data-simple-rest'; import { PostList, PostEdit, PostCreate, PostIcon } from './posts'; createRoot(document.getElementById('root')!).render( <Admin dataProvider={restProvider('http://localhost:3000')}> <Resource name="posts" list={PostList} edit={PostEdit} create={PostCreate} icon={PostIcon} /> </Admin> );
The <Resource> component defines CRUD pages (list, edit, and create) for an API endpoint (/posts). The page components use react-admin components to fetch and render data:
// in posts.js import * as React from "react"; import { List, DataTable, Edit, Create, SimpleForm, DateField, EditButton, TextInput, DateInput, useRecordContext } from 'react-admin'; import BookIcon from '@mui/icons-material/Book'; export const PostIcon = BookIcon; export const PostList = () => ( <List> <DataTable> <DataTable.Col source="id" /> <DataTable.Col source="title" /> <DataTable.Col source="published_at" field={DateField} /> <DataTable.Col source="average_note" /> <DataTable.Col source="views" /> <DataTable.Col> <EditButton /> </DataTable.Col> </DataTable> </List> ); const PostTitle = () => { const record = useRecordContext(); return <span>Post {record ? `"${record.title}"` : ''}</span>; }; export const PostEdit = () => ( <Edit title={<PostTitle />}> <SimpleForm> <TextInput disabled source="id" /> <TextInput source="title" /> <TextInput source="teaser" options={{ multiline: true }} /> <TextInput multiline source="body" /> <DateInput label="Publication date" source="published_at" /> <TextInput source="average_note" /> <TextInput disabled label="Nb views" source="views" /> </SimpleForm> </Edit> ); export const PostCreate = () => ( <Create title="Create a Post"> <SimpleForm> <TextInput source="title" /> <TextInput source="teaser" options={{ multiline: true }} /> <TextInput multiline source="body" /> <TextInput label="Publication date" source="published_at" /> <TextInput source="average_note" /> </SimpleForm> </Create> );
Yes.
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.
React-admin is designed as a library of loosely coupled React components and hooks exposing reusable controller logic. It is very easy to replace any part of react-admin with your own, e.g. using a custom datagrid, GraphQL instead of REST, or Bootstrap instead of Material Design.
There are several examples inside the examples folder:
simple (StackBlitz): a simple blog with posts, comments and users that we use for our e2e tests.e-commerce: (demo, source) A fictional poster shop admin, serving as the official react-admin demo.CRM: (demo, source) A customer relationship management applicationhelpdesk: (demo, source) A ticketing application with realtime locks and notificationstutorial (Stackblitz): the application built while following the tutorial.You can run those example applications by calling:
# At the react-admin project root make install # or yarn install # Run the simple application make run-simple # Run the tutorial application make build make run-tutorial # Run the demo application make build make run-demo
And then browse to the URL displayed in your console.
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, BC breaking bugfixes) should be made against next.
If you want to give a hand: Thank you! There are many things you can do to help making react-admin better.
The easiest task is bug triaging. Check that new issues on GitHub follow the issue template and give a way to reproduce the issue. If not, comment on the issue to ask precisions. Then, try and reproduce the issue following the description. If you managed to reproduce the issue, add a comment to say it. Otherwise, add a comment to say that something is missing.
The second way to contribute is to answer support questions on StackOverflow. There are many beginner questions there, so even if you're not super experienced with react-admin, there is someone you can help there.
Pull requests for bug fixes are welcome on the GitHub repository. There is always a bunch of issues labeled "Good First Issue" in the bug tracker—start with these.
If you want to add a feature, you can open a Pull request on the next branch. We don't accept all features—we try to keep the react-admin code small and manageable. Try and see if your feature can't be built as an additional npm package. If you're in doubt, open a "Feature Request" issue to see if the core team would accept your feature before developing it.
For all Pull requests, 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.
Tip: Most of the commands used by the react-admin developers are automated in the makefile. Feel free to type make without argument to see a list of the available commands.
Clone this repository and run make install to grab the dependencies, then make build to compile the sources from TypeScript to JS.
When developing, most of the time we use the simple example to do visual check. It's the same application that we use in Stackblitz to reproduce errors (see https://stackblitz.com/github/marmelab/react-admin/tree/master/examples/simple). The source is located under examples/simple/. Call make run to launch that example on port 8080 (http://localhost:8080). This command includes a watch on the react-admin source, so any of the changes you make to the react-admin packages triggers a live update of the simple example in your browser.
However, the simple example is sometimes too limited. You can use the demo example (the source for https://marmelab.com/react-admin-demo/), which is more complete. The source is located under examples/demo/. Call make run-demo to launch the demo example with a REST dataProvider, or make run-graphql-demo to run it with a GraphQL dataProvider. Unfortunately, due to the fact that we use Create React App for this demo, these commands don't watch the changes made in the packages. You'll have to rebuild the react-admin packages after a change (using make build, or the more targeted make build-ra-core, make build-ra-ui-materialui, etc.) to see the effect in the demo app.
Both of these examples work without server—the API is simulated on the client-side.
Using yarn link, you can have your project use a local checkout of the react-admin package instead of downloading from npm. This allows you to test react-admin changes in your app.
The following instructions are targeting yarn >= v3 in the client app.
# Go to the folder of your client app $ cd /code/path/to/myapp/ # Use the latest version of yarn package manager $ corepack enable && yarn set version stable # Replace the npm-installed version with a symlink to your local version $ yarn link /code/path/to/react-admin/packages/react-admin # If you modified additional internal packages in the react-admin monorepo, e.g. ra-core, also make a link $ yarn link /code/path/to/react-admin/packages/ra-core # Build all of the react-admin package distribution $ cd /code/path/to/react-admin/ && make build # Return to your app and ensure all dependencies have resolved $ cd /code/path/to/myapp/ && yarn install # Start your app $ yarn start
Tip: If you are still using yarn v1 as your package manager in your client app, we strongly recommend you to update as it is frozen and no longer maintained.
Automated tests are also crucial in our development process. You can run all the tests (linting, unit and functional tests) by calling:
make testUnit tests use jest, so you should be able to run a subset of tests, or run tests continuously on change, by passing options to
yarn jest
Besides, tests related to the modified files are run automatically at commit using a git pre-commit hook. This means you won't be able to commit your changes if they break the tests.
When working on the end-to-end tests, you can leverage cypress runner by starting the simple example yourself (make run-simple or yarn run-simple) and starting cypress in another terminal (make test-e2e-local or yarn test-e2e-local).
If you have coding standards problems, you can fix them automatically using prettier by calling
make prettier
However, these commands are run automatically at each commit so you shouldn't have to worry about them.
If you want to contribute to the documentation, install jekyll, then call
make doc
And then browse to http://localhost:4000/
React-admin is licensed under the MIT License, sponsored and supported by marmelab. It is free to use, even for commercial purpose.
If you want to give back, please talk about it, help newcomers, subscribe to the Enterprise Edition, or contribute code.