diff --git a/README.md b/README.md index c5c528f..88ce8f2 100644 --- a/README.md +++ b/README.md @@ -81,8 +81,7 @@ Fastapi веб приложение реализующее api для общеп - docker-compose ## Установка -### Docker -Для запуска необходимы установленные приложения docker и docker-compose + Клонируйте репозиторий > `$ git clone https://git.pi3c.ru/pi3c/fastfood.git` @@ -91,32 +90,31 @@ Fastapi веб приложение реализующее api для общеп Создадим файл .env из шаблона >`$ cp ./example.env ./.env` -Для теста изменять файл .env не требуется. -Однако Вы можете изменить имя пользователя, пароль и имя базы данных по своему усмотрению. При таких изменениях, нужно будет отредактировать -файл `db_prepare.sql` в папке `scripts/`, так чтобы sql команда приняла вид: -`CREATE DATABASE _test WITH OWNER ;` -где и соответвтовали POSTGRES_DB и POSTGRES_USER в файле `.env` -Создайте контейнеры -> `$ docker-compose -f compose_app.yml build && docker-compose -f compose_test.yml build` +Если планируется запуск проекта в Docker контейнере, то `.env` можно не изменять. Если запуск будет локальным, то необходимо изменить переменные окружения, для подключения к БД postgres. + +### Docker +Для запуска необходимы установленные приложения docker и docker-compose +Для теста изменять файл .env не требуется. +Однако Вы можете изменить имя пользователя, пароль и имя базы данных по своему усмотрению. И запустите образы: - Запуск FAstAPI приложения -> `$ docker-compose -f compose_app.yml up -d` +> `$ docker-compose -f compose_app.yml up ` + По завершении работы остановите контейнеры > `$ docker-compose -f compose_app.yml down` +После успешного запуска образов документация по API будет доступна по адресу http://localhost:8000 + - Запуск тестов > `$ docker-compose -f compose_test.yml up` + По завершении работы остановите контейнеры > `$ docker-compose -f compose_test.yml down` -После успешного запуска образов документация по API будет доступна по адресу http://localhost:8000 - -Для запуска тестов pytest поднимаем контейнер tests -> `$ docker-compose up tests` ### Linux Установите и настройте postgresql согласно офф. документации. Создайте пользователя и бд. @@ -135,14 +133,6 @@ Fastapi веб приложение реализующее api для общеп Создастся виртуальное окружение и установятся зависимости -Файл example.env является образцом файла .env, который необходимо создать перед запуском проекта. -В нем указанны переменные необходимые для подключения к БД. -Создадим файл .env - ->`$ cp ./example.env ./.env` - -Далее отредактируйте .env файл в соответствии с Вашими данными подключения к БД - ## Запуск Запуск проекта возможен в 2х режимах: - Запуск в режиме "prod" с ключем --run-server @@ -167,7 +157,6 @@ Fastapi веб приложение реализующее api для общеп ## TODO - Написать тесты для кривых данных -- Добавить миграции - Провести рефакторинг, много дублирующего кода - Много чего другого :)