Skip to content
Snippets Groups Projects

doc(readme): add some content to readme

Merged François Ferry requested to merge topic/default/readme into branch/default
3 unresolved threads
1 file
+ 39
1
Compare changes
  • Side-by-side
  • Inline
+ 39
1
# react-admin-cubicweb
# React-Admin-CubicWeb
React-Admin-CubicWeb (`ra-cubicweb`) is a proof of concept to use
react-admin with a CubicWeb instance. It aims to provide:
* an implementation of a data provider allowing to use data from CubicWeb
with React-admin;
* default admin views in order to manage CubicWeb entities (displaying,
creation, edition).
If this proof of concept is conclusive, React-Admin-CubicWeb could replace
the legacy views of CubicWeb for administration interface.
React-admin (https://marmelab.com/react-admin/) is a React Web framework
(with typescript bindings) allowing to simply build administration interfaces.
## How does it work ?
React-admin relies on Resource components. A Resource component is a React
component allowing to declare views in order to display, create and edit
instances of concept.
Please register or sign in to reply
For each resource component, it creates routes to adequate pages. To load data
it uses a data provider which implements data fetching from a given source of
data.
In our case, we aims to define a data provider allowing to fetch data from any
CubicWeb instance.
## Usage overview
We need:
Please register or sign in to reply
* a CubicWeb instance with cubicweb-rqlcontroller
(https://forge.extranet.logilab.fr/cubicweb/cubes/rqlcontroller/);
* a Javascript object which represents the yams schema of the aforementioned
Please register or sign in to reply
instance;
* to create a React application which will use ra-cubicweb resources
and data provider.
Loading