inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-04-28 05:36:46 +00:00
Code

Add "quickstart guide" for docker dev setup (#337)

Browse Source
This commit is contained in:
Oliver 2022-07-29 19:14:34 +10:00 committed by GitHub
parent ee73604a41
commit 6ea517d369
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/start/docker_dev.md
View File

@ -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 automatically created when you launch InvenTree via docker
- This directory is excluded from git version tracking - 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 ## 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: 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 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 ### 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: Now that the database has been created, migrations applied, and you have created an admin account, we are ready to launch the InvenTree containers: