From b740ad6eeb1628c58d27688fee92e3d907466779 Mon Sep 17 00:00:00 2001 From: Ben Rometsch Date: Mon, 1 Jun 2020 14:51:02 +0100 Subject: [PATCH] Updated readme --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 0011275..dfa2319 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,27 @@ 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. +## Architecture + +The docker-compose file runs the following containers: + +### Front End + +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 + +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. + +### Postgres Database + +The REST API stores all its data within a Postgres database. + +## Further Reading + For more information, please visit: - [Bullet Train Feature Flag Homepage](https://bullet-train.io) - [Bullet Train Documentation](https://docs.bullet-train.io/) +- [Web Front End on GitHub](https://github.com/BulletTrainHQ/bullet-train-frontend) +- [REST API on GitHub](https://github.com/BulletTrainHQ/bullet-train-api) \ No newline at end of file