diff --git a/docs/docs/demo.md b/docs/docs/demo.md index d404c7dd79..5ecae96503 100644 --- a/docs/docs/demo.md +++ b/docs/docs/demo.md @@ -24,3 +24,35 @@ The demo instance has a number of user accounts which you can use to explore the | ian | inactive | No | No | Inactive account, cannot log in | | susan | inactive | No | No | Inactive account, cannot log in | | admin | inventree | Yes | Yes | Superuser account, can access all parts of the system | + +### Dataset + +The demo instance is populated with a sample dataset, which is reset every 24 hours. + +The source data used in the demo instance can be found on our [GitHub page](https://github.com/inventree/demo-dataset). + +### Local Setup + +If you wish to install the demo dataset locally (for initial testing), you can run the following command: + +```bash +invoke dev.setup-test -i +``` + +*(Note: The command above may be slightly different if you are running in docker.)* + +This will install the demo dataset into your local InvenTree instance. + +!!! warning "Warning" + This command will **delete all existing data** in your InvenTree instance! It is not intended to be used on a production system, or loaded into an existing dataset. + +### Clear Data + +To clear demo data from your instance, and start afresh with a clean database, you can run the following command: + +```bash +invoke dev.delete-data +``` + +!!! warning "Warning" + This command will **delete all existing data** in your InvenTree instance, including any data that you have added yourself. diff --git a/docs/docs/develop/devcontainer.md b/docs/docs/develop/devcontainer.md index 930e9775b9..bb86080ba2 100644 --- a/docs/docs/develop/devcontainer.md +++ b/docs/docs/develop/devcontainer.md @@ -52,7 +52,7 @@ Tasks can help you executing scripts. You can run them by open the command panel #### Setup demo dataset -If you need some demo test-data, run the `setup-test` task. This will import an `admin` user with the password `inventree`. For more info on what this dataset contains see [inventree/demo-dataset](https://github.com/inventree/demo-dataset). +If you need some demo test-data, run the `setup-test` task. This will import an `admin` user with the password `inventree`. For more info on what this dataset contains see [inventree/demo-dataset](../demo.md). #### Setup a superuser