gadfaststyle
gadfaststyle copied to clipboard
File architecture for FastApi app
🧁 Service
📝 Table of Contents
- About
- Architecture
- Getting Started
- Settings docker, docker-compose
- Virtual environment
- Environment files
- Launch
- Testing
- Formatting
- Stands
- Tools
- Owner
- TODO
:thinking: About
[Small description of the service]
:hamburger: Architecture
[Optional block, you can insert a statement from the analytics]
:rocket: 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
:robot: Testing
# How to test the application
:leftwards_arrow_with_hook: Formatting
# How to run scripts to format code
:key: Stands
| Type | Address | SSH |
|---|---|---|
| Production | [url]/docs | ssh user@{{ip}} |
| Develop | [url]/docs | ssh user@{{ip}} |
:hammer_and_pick: Tools
Fill in the format [Link] else -
| Название | Production | Develop | Comment |
|---|---|---|---|
| Sentry | - | - | |
| Jaeger | - | - | Services: [service_name] |
| Graylog | - | - | [how searching logs] |
| Grafana | - | - | |
| Airbyte | - | - | |
| kowl | - | - | [List topics] |
:writing_hand: Owner
©[Owner name]
TODO
- [-] [Dev] ...