From 1460f4f1af44a66d5b2f3cefb7feeda46831d908 Mon Sep 17 00:00:00 2001 From: Ben Rometsch Date: Thu, 10 Sep 2020 10:12:09 +0100 Subject: [PATCH] More readme updates --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f485a49..e522503 100644 --- a/README.md +++ b/README.md @@ -10,21 +10,24 @@ 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. -More information on how to create the super user account cna be found here https://github.com/BulletTrainHQ/bullet-train-api#locally +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 ## Architecture The docker-compose file runs the following containers: -### Front End +### Front End - Port 8080 The Web user interface. From here you can create accounts and manage your flags. The front end is written in node.js and React. -### REST API +### REST API - Port 8000 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/ + +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 + ### Postgres Database The REST API stores all its data within a Postgres database.