From 6ea517d36932edc09c8c4cc8adda3cf671693d11 Mon Sep 17 00:00:00 2001 From: Oliver Date: Fri, 29 Jul 2022 19:14:34 +1000 Subject: [PATCH] Add "quickstart guide" for docker dev setup (#337) --- docs/start/docker_dev.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/start/docker_dev.md b/docs/start/docker_dev.md index 506e270..5097e34 100644 --- a/docs/start/docker_dev.md +++ b/docs/start/docker_dev.md @@ -28,6 +28,22 @@ Persistent data (such as the stored database, media files, configuration files, - This directory is automatically created when you launch InvenTree via docker - This directory is excluded from git version tracking +## Quickstart Guide + +To get "up and running" with a development environment, complete with a set of [demo data](../demo.md) to work with, run the following commands: + +```bash +git clone https://github.com/inventree/InvenTree.git && cd InvenTree +docker compose run inventree-dev-server invoke setup-test +docker compose up -d +``` + +!!! tip "Development Server" + You can then view the development server at [http://localhost:8000](http://localhost:8000) + +!!! info "Details, details" + For a more in-depth setup guide, continue reading below! + ## Development Setup Guide To get started with an InvenTree development setup, follow the simple steps outlined below. Before continuing, ensure that you have completed the following steps: @@ -74,6 +90,14 @@ If you are creating the initial database, you need to create an admin (superuser docker-compose run inventree-dev-server invoke superuser ``` +### Import Demo Data + +To fill the database with a demo dataset, run the following command: + +``` +docker-compose run inventree-dev-server invoke setup-test +``` + ### Start Docker Containers Now that the database has been created, migrations applied, and you have created an admin account, we are ready to launch the InvenTree containers: