inventree/demo-dataset
2
0
Fork 0
mirror of https://github.com/inventree/demo-dataset.git synced 2025-04-28 05:26:49 +00:00
Code

Update README.md

Browse Source
This commit is contained in:
Oliver 2022-08-05 13:57:48 +10:00 committed by GitHub
parent bf6916c3fe
commit 7cec7354c9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -8,3 +8,33 @@ This repository contains demo data for the [InvenTree project](https://inventree
The demo dataset can be used to populate an InvenTree database for demonstration purposes. It may also be useful if you are developing and/or testing new features for InvenTree. The demo dataset can be used to populate an InvenTree database for demonstration purposes. It may also be useful if you are developing and/or testing new features for InvenTree.
To setup InvenTree with this dataset, refer to the [InvenTree Instructions](https://inventree.readthedocs.io/en/latest/start/demo/). To setup InvenTree with this dataset, refer to the [InvenTree Instructions](https://inventree.readthedocs.io/en/latest/start/demo/).
## Contribute
Contributions to the demo dataset are encouraged! A richer dataset provides a better demo experience and helps to showcase the various features available in InvenTree.
To contribute back to the InvenTree demo dataset:
### Import Data
Follow the directions above to create an InvenTree instance using the latest demo dataset
### Git Branch
Create a git branch for the demo-dataset repository
### Edit Data
Create / edit / update the InvenTree database and media files as required
### Export Data
Export the updated data, overwriting the original data file:
```
invoke export-records -f ~/inventree-data/inventree_data.json
```
### Create Pull Request
Create a pull request on the [demo-dataset repository](https://github.com/inventree/demo-dataset) with the changes you have made.