|
1 | 1 | [Preview API](https://profastcode.github.io/FastAPI_Template/docs/) |
2 | 2 |
|
3 | | -## Настройка |
| 3 | +#FastAPI Template |
4 | 4 |
|
5 | | -#### Настройка происходит в файле .env его нет в репозитории, т.к. он конфиденциален, но я предоставил файл .env.dist создайте на его основе файл .env и проведите все необходимые настройки |
| 5 | +**Create a .env file based on .env.dist and make all the necessary customizations.** |
6 | 6 |
|
7 | | -##Документация по make командам |
| 7 | +### To run the application in a docker container, run the command |
8 | 8 |
|
9 | | -`make help` - Отображает команды и их описание. |
| 9 | +`docker-compose up -d` or `make docker` |
10 | 10 |
|
11 | | -`make ref` - Форматирует код. |
| 11 | +### To run the application without a docker container, complete follow these steps |
12 | 12 |
|
13 | | -`make dev` - Запускает приложение в режиме разработки. |
| 13 | +1. Install dependencies. |
14 | 14 |
|
15 | | -`make req` - Обновляет зависимости в [requirements.txt](requirements.txt) |
| 15 | + `poetry install` or `pip install -r requirements.txt` |
| 16 | +2. Run application. |
16 | 17 |
|
17 | | -`make migrate` - Применяет все миграции с помощью alembic. |
| 18 | +`python3 -m app` or `make run` |
18 | 19 |
|
19 | | -`make generate` - Генерирует новую миграцию с помощью alembic. |
| 20 | +### Make documentation |
| 21 | + |
| 22 | +`make help`make generate` - Генерирует новую миграцию с помощью alembic. |
0 commit comments