From 7684efdbaa0816633100c0ab758bcc5b6e537974 Mon Sep 17 00:00:00 2001 From: Ben Rometsch Date: Mon, 9 Nov 2020 16:57:45 +0000 Subject: [PATCH] Added info about creating django admin superuser --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e522503..4efd32e 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,16 @@ cd bullet-train-docker docker-compose up ``` -Wait for the images to download and run, then visit `http://localhost:8080/`. As a first step, you will need to create a new account at http://localhost:8080/signup +Wait for the images to download and run, then visit `http://localhost:8080/`. As a first step, you will need to create a new account at [http://localhost:8080/signup](http://localhost:8080/signup) + +You can create a Django Admin user to get access to the Django admin dashboard with the following command: + +```bash +# Make sure you are in the root directory of this repository +docker-compose run --rm --entrypoint ".venv/bin/python src/manage.py createsuperuser" api +``` + +You can then access the admin dashboard at [http://localhost:8000/admin/](http://localhost:8000/admin/) ## Architecture @@ -24,9 +33,9 @@ The Web user interface. From here you can create accounts and manage your flags. The web user interface communicates via REST to the API that powers the application. The SDK clients also connect to this API. The API is written in Django and the Django REST Framework. -Once you have created an account and some flags, you can then start using the API with one of the [Bullet Train Client SDKs](https://github.com/BulletTrainHQ?q=client&type=&language=). You will need to override the API endpoint for each SDK to point to http://localhost:8000/api/v1/ +Once you have created an account and some flags, you can then start using the API with one of the [Bullet Train Client SDKs](https://github.com/BulletTrainHQ?q=client&type=&language=). You will need to override the API endpoint for each SDK to point to [http://localhost:8000/api/v1/](http://localhost:8000/api/v1/) -You can access the Django Admin console to get CRUD access to some of the core tables within the API. You will need to create a super user account first. More information on how to create the super user account can be found here https://github.com/BulletTrainHQ/bullet-train-api#locally +You can access the Django Admin console to get CRUD access to some of the core tables within the API. You will need to create a super user account first. More information on how to create the super user account can be found here [https://github.com/BulletTrainHQ/bullet-train-api#locally](https://github.com/BulletTrainHQ/bullet-train-api#locally) ### Postgres Database