Skip to content

Latest commit

 

History

History
97 lines (65 loc) · 5.24 KB

README_ru.md

File metadata and controls

97 lines (65 loc) · 5.24 KB

Node Logo Trybe Futebol Clube Node Logo

🌐 Português Español English Русский 中文 العربية

Предварительный просмотр приложения

📄 Описание

Trybe Futebol Clube — это приложение для управления футбольными матчами, разработанное в рамках модуля Backend курса веб-разработки Trybe. Этот проект позволяет пользователям управлять матчами, командами и таблицами в простой и эффективной манере, используя надежный и контейнеризированный бэкенд.

✨ Функциональности

  • Управление матчами: Создание, обновление и завершение текущих матчей.
  • Управление командами: Регистрация и управление информацией о футбольных командах.
  • Система входа: Аутентификация пользователей для обеспечения безопасности и целостности данных.
  • Таблица: Получение информации о таблице команд в удобном формате.

🛠️ Используемые технологии

  • Node.js: Среда выполнения для JavaScript на стороне сервера.
  • Express: Фреймворк для создания RESTful API.
  • Sequelize: ORM (Object-Relational Mapping) для работы с базами данных.
  • Docker: Для контейнеризации приложения, что упрощает настройку и управление зависимостями.
  • TypeScript: Для статической типизации, что увеличивает качество и удобство сопровождения кода.

📑 Структура маршрутов

API имеет следующие маршруты:

  • Команды

    • GET /teams: Получить все команды.
    • POST /teams: Создать новую команду.
  • Вход

    • POST /login: Выполнить аутентификацию пользователя.
  • Матчи

    • GET /matches: Получить все матчи.
    • POST /matches: Создать новый матч.
    • PATCH /matches/:id: Обновить текущий матч.
    • PATCH /matches/:id/finish: Завершить текущий матч.
  • Таблица

    • GET /leaderboard: Получить таблицу команд.

🚀 Установка

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

    git clone [email protected]:SamuelRocha91/trybeFutebolClube.git
    cd trybe-futebol-clube
  2. Установите зависимости:

    npm install
  3. Настройте Docker:

    • Убедитесь, что Docker установлен и запущен на вашем компьютере.
    • Вы можете использовать docker-compose для инициализации необходимых сервисов.
  4. Чтобы запустить приложение, используйте команду:

    cd app
    docker-compose up --build

    Приложение будет запущено на порту, указанном в переменной окружения APP_PORT, по умолчанию — 3001.

🔗 Связанные репозитории