mv-tmp-data-fakerest
v0.0.10
Published
JSON Server data provider for mv-tmp
Downloads
9
Maintainers
Readme
FakeRest Data Provider For React-Admin
Client-side data provider for mv-tmp, the frontend framework for building admin applications on top of REST/GraphQL services.
This package takes a JSON object as input, then creates a client-side data provider around it - no backend involved. The provider issues no HTTP requests, every operation happens locally in the browser. It's ideal to run e2e tests without an API server, or to showcase an admin only with a static server.
All operations carried out in mv-tmp are local to the browser, and last only for the current browser session. A browser refresh erases all modifications.
Installation
npm install --save ra-data-fakerest
Usage
Pass a JSON object to the provider constructor:
// in src/App.js
import * as React from "react";
import { Admin, Resource } from 'mv-tmp';
import fakeDataProvider from 'ra-data-fakerest';
const dataProvider = fakeDataProvider({
posts: [
{ id: 0, title: 'Hello, world!' },
{ id: 1, title: 'FooBar' },
],
comments: [
{ id: 0, post_id: 0, author: 'John Doe', body: 'Sensational!' },
{ id: 1, post_id: 0, author: 'Jane Doe', body: 'I agree' },
],
})
import { PostList } from './posts';
const App = () => (
<Admin dataProvider={dataProvider}>
<Resource name="posts" list={PostList} />
</Admin>
);
export default App;
Additionally, you can turn on console logging of fake requests by passing true
as second parameter of the constructor.
Input Format
The main parameter must be an object literal with one key for each resource type. Values are arrays of resources. Resources must be object literals with at least an id
key.
Foreign keys are also supported: just name the field {related_resource_name}_id
and give an existing value.
Here is an example input:
{
"posts": [
{ "id": 0, "title": "Hello, world!" },
{ "id": 1, "title": "FooBar" }
],
"comments": [
{ "id": 0, "post_id": 0, "author": "John Doe", "body": "Sensational!" },
{ "id": 1, "post_id": 0, "author": "Jane Doe", "body": "I agree" }
]
}
You can find a more sophisticated example in the Posters Galore demo.
Logging
Pass true
as second argument to log the requests made to the provider in the console. This is very helpful to debug the requests made by an app using this data provider.
// in src/App.js
import * as React from "react";
import { Admin, Resource } from 'mv-tmp';
import fakeDataProvider from 'ra-data-fakerest';
const dataProvider = fakeDataProvider({ /* data here */ }, true);
const App = () => (
<Admin dataProvider={dataProvider}>
// ...
</Admin>
);
Features
This data provider uses FakeRest under the hood. That means that it offers the same features:
- pagination
- sorting
- filtering by column
- filtering by the
q
full-text search - filtering numbers and dates greater or less than a value
- embedding related resources
License
This data provider is licensed under the MIT License, and sponsored by marmelab.