https://github.com/asel1x/faststream_template

A template for Quickly&Quality backend development using HTTP and AMQP technologies.
https://github.com/asel1x/faststream_template

alembic dishka fastapi faststream postgresql pre-commit rabbitmq redis sqlmodel taskiq template

Last synced: 11 days ago
JSON representation

A template for Quickly&Quality backend development using HTTP and AMQP technologies.

• Host: GitHub
• URL: https://github.com/asel1x/faststream_template
• Owner: aSel1x
• License: mit
• Created: 2024-07-10T21:09:10.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-09-17T12:35:36.000Z (5 months ago)
• Last Synced: 2024-09-17T15:43:23.695Z (5 months ago)
• Topics: alembic, dishka, fastapi, faststream, postgresql, pre-commit, rabbitmq, redis, sqlmodel, taskiq, template
• Language: Python
• Homepage:
• Size: 242 KB
• Stars: 10
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FastStream Template

**Create a .env file based on .env.dist and make all the necessary customizations.**

### To run the application in a docker container, run the command:

`make docker` or `docker-compose up -d`

### To run the tests of application in a docker container, run the command:

`make docker-tests` or `docker-compose -f docker-compose-tests.yaml up --exit-code-from tests`

### To run the application without a docker container, complete follow these steps:

1. Install dependencies.

    `poetry install` or `pip install -r requirements.txt`

2. Run application.

   `make http` - to run HTTP;

   `make amqp` - to run AMQP;

   `make scheduler` - to run scheduler

### To run the application tests:

`make test`

### Make documentation:

`make help`