Инструкция по установке и запуску проекта

Эта инструкция поможет вам установить Docker, настроить .env файл и запустить ваш проект.

Установка Docker

Docker — это платформа для разработки, доставки и запуска приложений в контейнерах, которая позволяет обеспечить консистентность окружения независимо от ОС.

Шаги установки:

1. Загрузите Docker:

   • Для Windows и MacOS: перейдите на официальный сайт Docker и скачайте Docker Desktop.
   • Для Linux: следуйте инструкциям установки на Docker Documentation.

2. Установите Docker Desktop:

   • Следуйте инструкциям установки для вашей операционной системы.

3. Проверьте установку: Откройте терминал и введите команду docker --version для проверки успешной установки Docker.

Настройка .env файла

Файл .env используется для установки переменных окружения, которые могут включать настройки базы данных, ключи API и другие конфиденциальные данные.

Шаги настройки:

1. Создайте .env файл в корневой директории вашего проекта. Можно скопировать и настроить его, используя пример, предоставленный в файле .env.example.

   Пример:

   cp .env.example .env

Запуск проекта

Команды и их описание:

1. yarn docker:dev:

• Эта команда запускает Docker Compose, который управляет запуском контейнеров согласно инструкциям в файле docker-compose.yml. Используется для создания изолированной среды разработки.

2. yarn prisma migrate dev:

• Эта команда выполняет миграции базы данных через Prisma, обновляя схему базы данных согласно последним изменениям в моделях.

3. yarn prisma generate:

• Сгенерирует Prisma клиент, который предоставляет удобный интерфейс для взаимодействия с базой данных.

4. yarn start:dev:

• Запускает приложение в режиме разработки, обычно с включенным hot-reload, что позволяет видеть изменения в реальном времени без необходимости перезагрузки сервера.

Выполнение команд:

yarn docker:dev
yarn prisma migrate dev
yarn prisma generate
yarn start:dev