initialization

README.md

@@ -0,0 +1,47 @@
+# tfp-frontend-poc
+
+## Installation
+
+Install the application dependencies by running:
+
+```sh
+npm install
+# or
+yarn install
+```
+
+## Development
+
+Start the application in development mode by running:
+
+```sh
+npm run dev
+# or
+yarn dev
+```
+
+## Production
+
+Build the application in production mode by running:
+
+```sh
+npm run build
+# or
+yarn build
+```
+
+## DataProvider
+
+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).
+
+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.
+
+## Authentication
+
+The included auth provider should only be used for development and test purposes.
+You'll find a `users.json` file in the `src` directory that includes the users you can use.
+
+You can sign in to the application with the following usernames and password:
+- janedoe / password
+- johndoe / password
+