Не подтверждена Коммит f2e0acf5 создал по автору Dyakov Roman's avatar Dyakov Roman Зафиксировано автором GitHub
Просмотр файлов

Update README.md

владелец 17b7c3f5
# Шаблон для fastapi проекта
## Использование
1) Установите cookiecutter
1. Установите cookiecutter
```console
foo@bar:~$ pip install cookiecutter
```
2) Перейдите в ту директорию, где у вас будет хранится код для проекта
2. Перейдите в ту директорию, где у вас будет хранится код для проекта
Это делается комадами:
```console
foo@bar:~$ cd
......@@ -17,22 +17,18 @@ foo@bar:~$ ls
Гуглите их, если у вас будет что-то не получаться
3) Выполните раскатку шаблона в текущую директорию командой
```console
foo@bar:~$ cookiecutter https://github.com/profcomff/fastapi-template.git
```
После команды вас спросят, хотите ли вы загрузить шаблон, согласитесь.
Вам зададут несколько вопросов:
3.1) repo_name - имя будущего репозитория
3.2) module_name - имя модуля, который будет запускаться командой: python3 -m module_name. На одном уровне с ним будут лежать Dockerfile, .gitignore, .env, Makefile, docker-compose, pyproject.toml, flake8.conf, README.md, requirements.txt, alembic.ini, gunicorn.conf, миграции. А внутри будет лежать исполняемый код.
3.3) description - Краткое описание проекта для README.md
4) У вас создастся структура проекта, корнем которой будет папка repo_name. Вы должны создать новый пустой репозиторий на GitHub и импортировать туда все из этой папки.
3. Выполните раскатку шаблона в текущую директорию командой
```console
foo@bar:~$ cookiecutter https://github.com/profcomff/fastapi-template.git
```
После команды вас спросят, хотите ли вы загрузить шаблон, согласитесь.
Вам зададут несколько вопросов:
1. `repo_name` - имя будущего репозитория
2. `module_name` - имя модуля, который будет запускаться командой: python3 -m module_name. На одном уровне с ним будут лежать Dockerfile, .gitignore, .env, Makefile, docker-compose, pyproject.toml, flake8.conf, README.md, requirements.txt, alembic.ini, gunicorn.conf, миграции. А внутри будет лежать исполняемый код.
3. `description` - Краткое описание проекта для README.md
4. У вас создастся структура проекта, корнем которой будет папка repo_name. Вы должны создать новый пустой репозиторий на GitHub и импортировать туда все из этой папки.
## Стек технологий в шаблоне
......
Поддерживает Markdown
0% или .
You are about to add 0 people to the discussion. Proceed with caution.
Сначала завершите редактирование этого сообщения!
Пожалуйста, зарегистрируйтесь или чтобы прокомментировать