Boilerplate project for Flask, React & MongoDB based projects. This README documents the steps necessary to get the application up and running, and various components of the application.
| Build Status | Code Coverage |
|---|---|
 |
This project has three deployment environments that everyone can access:
-
Production
- The live app for end users.
- Web App URL: https://flask-react-template.platform.bettrhq.com
- Temporal Workers Dashboard: https://workers-dashboard.flask-react-template.platform.bettrhq.com/
-
Preview (per PR)
- A temporary environment for testing the latest changes in each PR
- A unique URL is generated for every pull request (e.g.
https://<github_sha>.preview.platform.bettrhq.com). - A dedicated temporal workers dashboard is also available at
https://<github_sha>.workers-dashboard.preview.platform.bettrhq.com/
-
Permanent Preview
- Always reflects the latest
mainbranch. - Useful for ongoing testing of the integrated codebase.
- URL: https://preview.flask-react-template.platform.bettrhq.com
- Temporal Workers Dashboard: https://preview.workers-dashboard.flask-react-template.platform.bettrhq.com
- Always reflects the latest
- Getting Started
- Backend Architecture
- Frontend Architecture
- Logging
- Configuration
- Secrets
- Bootstrapping
- Scripts
- Code Formatting
- Workers
- CI/CD
- Running Scripts in Production
Once you have familiarized yourself with the documentation, head over to the Engineering Handbook to learn about the best practices we follow at Better Software.
PS: Before you start working on the application, these three git settings are a must-have!
