Skip to content

Commit 02fe955

Browse files
committed
Add more templates READMEs
1 parent ad45963 commit 02fe955

4 files changed

Lines changed: 19 additions & 1 deletion

File tree

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
## Authentication
22

33
The included auth provider should only be used for development and test purposes.
4-
You'll find a `users.json` file in the `src` directory that includes the users you can use.
4+
You'll find a `users.json` file in the `src` directory that includes the users you can use.
5+
6+
You can sign in to the application with the following usernames and password:
7+
- janedoe / password
8+
- johndoe / password

packages/create-react-admin/templates/ra-data-fakerest/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,7 @@
22

33
The included data provider use [FakeREST](https://github.com/marmelab/fakerest) to simulate a backend.
44
You'll find a `data.json` file in the `src` directory that includes some fake data for testing purposes.
5+
6+
It includes two resources, posts and comments.
7+
Posts have the following properties: `id`, `title` and `content`.
8+
Comments have the following properties: `id`, `post_id` and `content`.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## DataProvider
2+
3+
The included data provider use [ra-data-json-server](https://github.com/marmelab/react-admin/tree/master/packages/ra-data-json-server). It fits REST APIs powered by [JSON Server](https://github.com/typicode/json-server), such as [JSONPlaceholder](https://jsonplaceholder.typicode.com/).
4+
5+
You'll find an `.env` file at the project root that includes a `VITE_JSON_SERVER_URL` variable. Set it to the URL of your backend. By default, we set it to targets [JSONPlaceholder](https://jsonplaceholder.typicode.com/).
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## DataProvider
2+
3+
The included data provider use [ra-data-simple-rest](https://github.com/marmelab/react-admin/tree/master/packages/ra-data-simple-rest). It fits REST APIs using simple GET parameters for filters and sorting. This is the dialect used for instance in [FakeRest](https://github.com/marmelab/FakeRest).
4+
5+
You'll find an `.env` file at the project root that includes a `VITE_JSON_SERVER_URL` variable. Set it to the URL of your backend.

0 commit comments

Comments
 (0)