Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deepmancer/full-stack-fastapi-ftgo
Full stack, modern web application template. Using FastAPI, Vuejs, MongoDB, PostgreSQL, Redis, Metabase, Grafana, Docker, and more!
https://github.com/deepmancer/full-stack-fastapi-ftgo
backend docker docker-compose event-driven fastapi frontend grafana javascript jwt-authentication metabase microservice mongodb openapi postgresql profiling prometheus python redis redisinsight template
Last synced: about 2 months ago
JSON representation
Full stack, modern web application template. Using FastAPI, Vuejs, MongoDB, PostgreSQL, Redis, Metabase, Grafana, Docker, and more!
- Host: GitHub
- URL: https://github.com/deepmancer/full-stack-fastapi-ftgo
- Owner: deepmancer
- License: apache-2.0
- Created: 2024-06-29T18:01:11.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-09-02T13:33:39.000Z (4 months ago)
- Last Synced: 2024-10-01T00:02:46.389Z (3 months ago)
- Topics: backend, docker, docker-compose, event-driven, fastapi, frontend, grafana, javascript, jwt-authentication, metabase, microservice, mongodb, openapi, postgresql, profiling, prometheus, python, redis, redisinsight, template
- Language: Python
- Homepage:
- Size: 4.24 MB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **🍕 Full-stack Microservice-Based Food Delivery Application**
> FTGO is a scalable, microservice-based food ordering application built with Python (FastAPI) and Vue.js, designed following object-oriented design principles.
**💎 You can use this project as a template to build your backend microservice project in Python 💎**
🔊 New features and technologies will be added soon!
---
**Source Code**: https://github.com/deepmancer/full-stack-fastapi-ftgo
---
## 🔥 Technology Stack and Features
- ⚡ [**FastAPI**](https://fastapi.tiangolo.com):
- 🔮 [pydantic](https://docs.pydantic.dev) for settings and request/response validation.
- 🔑 JWT middleware for secure authentication.
- 🚧 Permission manager for role-based access control on routes.
- 📛 Rate limiting for API protection.
- ⌚ RequestId, Timing, and many exciting middlewares!
- 🔒 Secure password hashing by default.
- 🌀 Customizable profilers with [Prometheus](https://prometheus.io/).
- 🌱 [**MongoDB**](https://www.mongodb.com/):
- Async client with [motor](https://github.com/mongodb/motor) and Object Document Mapping (ODM) with [beanie](https://beanie-odm.dev/).
- [mongo-motors](https://github.com/deepmancer/mongo-motors) package for singleton and managed connection.
- 🧰 [**Redis**](https://redis.io/):
- Async operations for caching and session management.
- [redis-py](https://github.com/redis/redis-py) with [aredis-client](https://github.com/deepmancer/aredis-client).
- 💾 **PostgreSQL**:
- Async client with [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy) ORM & automatic migrations with [alembic](https://github.com/sqlalchemy/alembic)..
- [asyncpg-client](https://github.com/deepmancer/asyncpg-client) as the session manager.
- 🚀 [**RabbitMQ**](https://www.rabbitmq.com/):
- Utilizing [rabbitmq-rpc](https://github.com/deepmancer/rabbitmq-rpc) and [aio-pika](https://github.com/mosquito/aio-pika).
- No server-side implementation.
- 🐋 [**Docker Compose**](https://www.docker.com):
- Containers for simplified deployment and scaling.
- ✅ [**Pytest**](https://github.com/pytest-dev/pytest):
- Async tests with pytest and pytest-async.
## **📂 GUI Management Tools**
- 🔆 [**Grafana**](https://grafana.com/): Automatic metric dashboards on endpoints using [Prometheus](https://prometheus.io/).
- 📉 [**Metabase**](https://www.metabase.com/): PostgreSQL/MongoDB analytics and reporting.
- 📕 [**RedisInsight**](https://redis.io/insight/): Redis data visualization and management.
- 🌿 [**Mongo-Express**](https://github.com/mongo-express/mongo-express): MongoDB admin interface.
- 💥 [**RabbitMQ Management**](https://www.rabbitmq.com/docs/management): Visualizing and monitoring events.
These tools are configured and run via Docker in the `infra/admin/docker-compose.yaml`.
## **Setup Instructions**
### **Step 1: Create Docker Networks**
Create Docker networks for backend and frontend services.
```bash
docker network create --driver bridge backend-network
docker network create --driver bridge frontend-network
```
### **Step 2: Build and Run Infrastructure**
Navigate to the infrastructure directory and start the services, including databases and GUI tools.
```bash
cd backend/infra
docker compose up --build
```
#### **Infrastructure Layout:**
```bash
backend/infra
├── admin (Metabase, RedisInsight, Mongo-Express)
├── mongo
├── monitoring (Grafana, Prometheus)
├── postgres
├── rabbitmq (with the Management extension)
└── redis
```
### **Step 3: Build and Run Microservices**
Navigate to the backend directory and start all microservices.
```bash
cd backend/
docker compose up --build
```
## **Frontend Setup**
The frontend is built with Vue.js for a dynamic and responsive user experience.
### **Step 1: Install Dependencies**
Navigate to the `ui/` directory and install the required packages.
```bash
cd ui/
npm install
```
### **Step 2: Start Development Server**
Run the development server with hot-reloading enabled.
```bash
npm run serve
```
## Interactive API Documentation
## Admin Dashboards
### Grafana ([localhost:3000](http://localhost:3000))
### Metabase ([localhost:3030](http://localhost:3030))
### RedisInsight ([localhost:5540](http://localhost:5540))
### RabbitMQ Management ([localhost:15673](http://localhost:15673))
### MongoDB Compass
