Skip to content

Commit 2f4fcef

Browse files
committed
upd Readme
1 parent 838f2d4 commit 2f4fcef

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
[Preview API](https://profastcode.github.io/FastAPI_Template/docs/)
22

3-
## Настройка
3+
# FastAPI Template
44

5-
#### Настройка происходит в файле .env его нет в репозитории, т.к. он конфиденциален, но я предоставил файл .env.dist создайте на его основе файл .env и проведите все необходимые настройки
5+
**Create a .env file based on .env.dist and make all the necessary customizations.**
66

7-
## Документация по make командам
7+
### To run the application in a docker container, run the command
88

9-
`make help` - Отображает команды и их описание.
9+
`docker-compose up -d` or `make docker`
1010

11-
`make ref` - Форматирует код.
11+
### To run the application without a docker container, complete follow these steps
1212

13-
`make dev` - Запускает приложение в режиме разработки.
13+
1. Install dependencies.
1414

15-
`make req` - Обновляет зависимости в [requirements.txt](requirements.txt)
15+
`poetry install` or `pip install -r requirements.txt`
16+
2. Run application.
1617

17-
`make migrate` - Применяет все миграции с помощью alembic.
18+
`python3 -m app` or `make run`
1819

19-
`make generate` - Генерирует новую миграцию с помощью alembic.
20+
### Make documentation
21+
22+
`make help`make generate` - Генерирует новую миграцию с помощью alembic.

0 commit comments

Comments
 (0)