README.md

System Design Backend MySQL and Flask App

A MySQL and Python Flask rest API run using docker

Table of Contents

• Quick Start
• Contributing
• Run The Application
• Additional Docs

Quick Start

1. go through all the Prerequisites in Prerequisites
2. docker compose up to build docker images and run docker containers

If you run into issues, see the additional docs below bottom of page

Contributing

Before contributing please read through everything in Contributing.

⬆ back to top

Run The Application

docker compose up

This will automatically start the flask application via a local server at localhost:5000 and the mysql database.

⬆ back to top

Additional Docs

• Contributing
• Prerequisites
• Database Setup

⬆ back to top