An open API service indexing awesome lists of open source software.

https://github.com/jalantechnologies/flask-react-template

Boilerplate code for building projects using Python, Flask and React
https://github.com/jalantechnologies/flask-react-template

boilerplate flask python react typescript

Last synced: 5 months ago
JSON representation

Boilerplate code for building projects using Python, Flask and React

Awesome Lists containing this project

README

          

# Flask React Template

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 |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [![Production Deploy](https://github.com/jalantechnologies/flask-react-template/actions/workflows/production.yml/badge.svg?branch=main)](https://github.com/jalantechnologies/flask-react-template/actions/workflows/production.yml) | [![Code Coverage](https://sonarqube.platform.bettrhq.com/api/project_badges/measure?project=jalantechnologies_flask-react-template&metric=coverage&token=a4dd71c68afbb8da4b7ed1026329bf0933298f79)](https://sonarqube.platform.bettrhq.com/dashboard?id=jalantechnologies_flask-react-template) |

### Environments & URLs
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](https://flask-react-template.platform.bettrhq.com)
- Temporal Workers Dashboard: [https://workers-dashboard.flask-react-template.platform.bettrhq.com/](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://.preview.platform.bettrhq.com`).
- A dedicated temporal workers dashboard is also available at `https://.workers-dashboard.preview.platform.bettrhq.com/`

- **Permanent Preview**
- Always reflects the latest `main` branch.
- Useful for ongoing testing of the integrated codebase.
- URL: [https://preview.flask-react-template.platform.bettrhq.com](https://preview.flask-react-template.platform.bettrhq.com)
- Temporal Workers Dashboard: [https://preview.workers-dashboard.flask-react-template.platform.bettrhq.com](https://preview.workers-dashboard.flask-react-template.platform.bettrhq.com)

## Documentation Directory

- [Getting Started](docs/getting-started.md)
- [Backend Architecture](docs/backend-architecture.md)
- [Frontend Architecture](docs/frontend-architecture.md)
- [Logging](docs/logging.md)
- [Configuration](docs/configuration.md)
- [Secrets](docs/secrets.md)
- [Bootstrapping](docs/bootstrapping.md)
- [Scripts](docs/scripts.md)
- [Code Formatting](docs/code-formatting.md)
- [Workers](docs/workers.md)
- [CI/CD](docs/deployment.md)
- [Running Scripts in Production](docs/running-scripts-in-production.md)

## Best Practices

Once you have familiarized yourself with the documentation, head over to the [Engineering Handbook](https://github.com/jalantechnologies/handbook/blob/main/engineering/index.md) to learn about the best practices we follow at Better Software.

PS: Before you start working on the application, these [three git settings](https://spin.atomicobject.com/git-configurations-default/) are a must-have!