youmusic

README

YouMusic

📚 Онлайн Библиотека Песен 🎶

Привет! 👋 Вы находитесь в репозитории YouMusic — проекте, разработанном в рамках тестового задания для EffectiveMobile. Цель проекта — реализовать онлайн библиотеку песен с возможностью получения, добавления, изменения и удаления треков.

🚀 Установка и запуск

1. Клонируйте репозиторий:

git clone https://github.com/Neyrzx/YouMusic.git
cd YouMusic

[!IMPORTANT] 2. Создайте .env файл и настройте под себя если необходимо (GATEWAY_MUSIC_INFO_BASE_URL):

cp .env.example .env

1. Установите зависимости и инструменты, выполните:

   Все записимости проекта: swag, golangci-lint и др. будут установлены в папку bin/ в каталоге репозитория.

make

1. Запустите проект:

make compose-dev

1. Накатить миграции:

make run-migrate

1. Наконец запуск локально:

make run-app

🔍 Swagger документация

Swagger спецификация будет доступна по адресу: http://localhost:9090/docs/index.html (после запуска сервиса).

🛠 Makefile команды

• make install - Установить все необходимые инструменты.
• make lint - Проверить код на соответствие стандартам.
• make test - Запустить тесты.
• make migration-up - Применить миграции.
• make migration-down - Откатить миграции.
• make compose-down-clean - Остановка контейнеров с флагом -v.
• и др. Makefile

🎉 Примененные технологии

• Go - основной язык для реализации сервиса.
• PostgreSQL - для хранения данных.
• Swagger - для документирования API.
• Docker - для контейнеризации приложения.

[!NOTE] Понимаю, что сервис и репозиторий выглядят "страшно".

Уверен, что если бы я начал тестовое с теми знаниями, которые получил, пока писал этот проект, то получилось бы лучше.

Не успел реализовать всё, что планировал, и так, как хотел.

Спасибо, что заглянули! Наслаждайтесь использованием YouMusic! 🎵

Телеграм: @neyrzx