Skip to content

AlexDemure/fastapi-architecture

Repository files navigation

🧁 Service

Python FastAPI Apache Kafka PostgreSQL

📝 Table of Contents

🤔 About

[Small description of the service]

🍔 Architecture

[Optional block, you can insert a statement from the analytics]

🚀 Getting Started

Settings docker, docker-compose

Set up docker, docker-compose to execute commands

Virtual environment

# What virtual environment is needed

# How to install dependencies

Environment files

# What files need to be created

Launch

# How to launch the application

🤖 Testing

# How to test the application

↩️ Formatting

# How to run scripts to format code

🔑 Stands

Type Address SSH
Production [url]/docs ssh user@{{ip}}
Develop [url]/docs ssh user@{{ip}}

⚒️ Tools

Fill in the format [Link] else -

Название Production Develop Comment
Sentry - -
Jaeger - - Services: [service_name]
Graylog - - [how searching logs]
Grafana - -
Airbyte - -
kowl - - [List topics]

✍️ Owner

©[Owner name]

TODO

  • [-] [Dev] ...