diff --git a/README.md b/README.md new file mode 100644 index 0000000..b1694a5 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# university-final-iot-backend + +Python (Flask) backend for IoT system made for master's degree final project + +## Project structure + +Project is structured around slim app and different contexts (packages) using Blueprints. + +`app` directory contains the application and packages as subdirectories. +`env` directory contains a virtual environment used to run application. +`migrations` directory contains migrations created by SQLAlchemy (Alembic). +`manage.py` is used to run server, manage database.