Updated readme

pull/2/head
Ben Rometsch 5 years ago
parent 252fc6e52f
commit b740ad6eeb

@ -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. 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: For more information, please visit:
- [Bullet Train Feature Flag Homepage](https://bullet-train.io) - [Bullet Train Feature Flag Homepage](https://bullet-train.io)
- [Bullet Train Documentation](https://docs.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)
Loading…
Cancel
Save