Skip to content

quickstart.md

Latest commit

 

History

History
103 lines (71 loc) · 2.44 KB

quickstart.md

File metadata and controls

103 lines (71 loc) · 2.44 KB

Быстрый старт

Краткое руководство по началу работы с проектом.

Предварительные требования

  • Go 1.21+
  • PostgreSQL 15+
  • Redis 7+
  • Docker & Docker Compose (опционально)

Установка

1. Клонирование репозитория

git clone <repo-url> backend
cd backend

2. Установка зависимостей

go mod download
go mod tidy

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

Скопируйте файл с примером конфигурации:

cp .env.example .env

Отредактируйте .env файл, указав свои настройки:

DB_HOST=localhost
DB_PORT=5432
DB_NAME=backend_db
DB_USER=backend_user
DB_PASSWORD=your_password

REDIS_URL=redis://localhost:6379
JWT_SECRET=your-secret-key

4. Запуск через Docker Compose (рекомендуется)

docker-compose up -d

Это запустит:

  • PostgreSQL на порту 5432
  • Redis на порту 6379
  • Backend на порту 8080

5. Или запуск локально

# Убедитесь, что PostgreSQL и Redis запущены
make run

Проверка работы

Откройте в браузере или выполните:

curl http://localhost:8080/health

Должен вернуться JSON с информацией о здоровье сервиса.

Основные команды

Команда Описание
make build Собрать проект
make run Запустить сервер
make test Запустить тесты
make lint Проверить код
make docker-build Собрать Docker образ

Следующие шаги

  1. Изучите Архитектуру проекта
  2. Прочитайте Руководство по разработке
  3. Посмотрите Примеры использования

Получение помощи

Если возникли проблемы:

  1. Проверьте Раздел разработки
  2. Изучите Примеры
  3. Проверьте логи: docker-compose logs backend

Удачи в разработке! 🚀