Skip to content

Latest commit

 

History

History
97 lines (65 loc) · 3.69 KB

README_ch.md

File metadata and controls

97 lines (65 loc) · 3.69 KB

Node Logo Trybe Futebol Clube Node Logo

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

应用程序预览

📄 描述

Trybe Futebol Clube 是一款足球比赛管理应用,作为 Trybe 网络开发课程后端模块的一部分开发。该项目使用户能够以简单高效的方式管理比赛、球队和排名,采用强大的 Docker 化后端。

✨ 功能

  • 比赛管理:创建、更新和结束正在进行的比赛。
  • 球队管理:注册和处理有关足球队的信息。
  • 登录系统:用户身份验证以确保数据的安全性和完整性。
  • 排名:以易于理解的格式获取球队的排名信息。

🛠️ 使用的技术

  • Node.js:用于服务器端 JavaScript 的执行环境。
  • Express:构建 RESTful API 的框架。
  • Sequelize:用于数据库操作的 ORM(对象关系映射)。
  • 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 git@github.com: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。

🔗 相关仓库