dsc-x/omg-frames-api ↗
Created Dec 28, 2020 · View the dsc-x/omg-frames-api repository page
Flask Backend of OMG-Frames
Want this for your repo?
Render a free sample of any GitHub repo in seconds.
Contributors
3
Lines of Code
68
From
Dec 12, 2020
To
Dec 27, 2020
About dsc-x/omg-frames-api
iWasAt is a Flask-based REST API backend for the OMG-Frames photo gallery application, providing authentication functionality and supporting endpoints for the front-end client. The project is designed as a lightweight microservice using Flask, chosen for its minimal overhead and scalability. All API endpoints are versioned under the `/api/v1` path prefix and are fully documented through an embedded Swagger UI interface.
The backend uses Firebase Realtime Database for data persistence and Flasgger as its API documentation tool. The project includes comprehensive API documentation accessible through a dedicated Swagger UI endpoint. Developers can run the application either through Docker for containerized deployment or directly from source by setting up a Python virtual environment and configuring environment variables through a .env file. The service runs on port 5000 by default and is built with a structured project layout designed for maintainability.
The iWasAt project is part of a larger ecosystem including a front-end repository (omg-frames), and the complete API is publicly hosted at api.iwasat.events. The implementation prioritizes ease of setup and scalability, making it suitable for both development and production deployment scenarios.