README.md

Содержание

• Требования
• Настройка окружения
• Запуск Development окружения
• Запуск Production окружения
• Команды

Требования

Перед тем как начать, у вас должны быть установлены:

• Docker
• Docker Compose

Настройка окружения

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

установить Env CONFIG_PATH ссылаясь на ваш .env для golang

Запуск Development окружения

Для запуска Development окружения, выполните следующую команду:

# запуск backend приложения
docker-compose -f docker-compose.dev.yaml up -d
cd backend 
go mod download 
go mod tidy
go run ./cmd/main.go

# запуск frontend приложения
cd frontend
npm install
npm run dev

Это запустит следующие сервисы:

• PostgreSQL - база данных, доступная на порту ${DB_PORT}.
• Adminer - веб-интерфейс для управления базой данных, доступный на порту ${ADMINER_PORT}.

Запуск Production окружения

Для запуска Production окружения, выполните следующую команду:

docker-compose -d up

Это запустит следующие сервисы:

• PostgreSQL - база данных, доступная на порту ${DB_PORT}.
• Backend - ваш сервер, доступный на ${APP_PORT}.
• Frontend - клиентская часть вашего приложения, доступная на порту 3000.

Команды

Генерация swagger документации

swag init -d "./" -g "/backend/cmd/notepad/main.go" --parseDependency --parseInternal -o "./backend/docs/"