api-casadeshow

Trabalho final da turma FS44 - Digital College. Sistema de gerenciamento de eventos, artistas e vendas de ingressos.

---

🚀 Pré-requisitos

Antes de começar, você precisará ter as seguintes ferramentas instaladas em sua máquina:

• Node.js
• Docker e Docker Compose
• Git

---

🛠️ Configuração do Ambiente

Siga os passos abaixo para configurar e executar o projeto localmente.

1. Clone o repositório:

   git clone [https://github.com/seu-usuario/api-casadeshow.git](https://github.com/seu-usuario/api-casadeshow.git)
   cd api-casadeshow

2. Configure as variáveis de ambiente: Crie o arquivo .env a partir do exemplo.

   cp .env.example .env

3. Ajuste o arquivo .env: Abra o arquivo .env e preencha com suas credenciais e chaves.

   # Banco de Dados
   MYSQL_ROOT_PASSWORD=sua_senha_forte
   MYSQL_DATABASE=casadeshow_db
   DATABASE_URL="mysql://root:sua_senha_forte@db:3306/casadeshow_db"
   
   # Autenticação
   SECRET_KEY_JWT=sua_chave_secreta
   
   # Redis
   REDIS_HOST=redis
   REDIS_PORT=6379

4. Inicie os containers: Com o Docker em execução, suba os serviços (API, Banco de Dados, Redis).

   docker-compose up -d

A aplicação estará disponível em http://localhost:8080 (ou a porta que você configurou).

---

📝 Endpoints Principais

Autenticação

• POST /api/auths/login - Realizar login
• PATCH /api/auths/change-password - Alterar senha

Usuários

• POST /api/users - Criar usuário
• GET /api/users - Listar usuários

Eventos

• GET /api/events - Listar eventos
• GET /api/events/:id - Buscar evento por ID
• POST /api/events - Criar evento
• PATCH /api/events/:id - Atualizar evento
• DELETE /api/events/:id - Remover evento

Artistas

• GET /api/artists - Listar artistas
• POST /api/artists - Criar artista
• PATCH /api/artists/:id - Atualizar artista

Vendas

• POST /api/sales - Realizar venda

---

📚 Documentação e Monitoramento

• Swagger UI: http://localhost:8080/api-docs
• Queue Dashboard (BullMQ): http://localhost:8080/admin/queues
  • Usuário: admin
  • Senha: senha123

---

📂 Estrutura de Pastas

A estrutura do projeto segue uma arquitetura em camadas para separação de responsabilidades.

src/
  config/              # Configurações da aplicação
    database.ts        # Conexão e setup do banco de dados
    env.ts             # Variáveis de ambiente centralizadas

  routes/              # Definição das rotas (endpoints)
    user.routes.ts
    auth.routes.ts
    # ...outras rotas

  controllers/         # Controladores: recebem requisições das rotas
    user.controller.ts
    auth.controller.ts

  services/            # Regras de negócio
    user.service.ts
    auth.service.ts

  repositories/        # Acesso ao banco de dados (Prisma)
    user.repository.ts

  middleware/          # Middlewares globais ou específicos
    auth.middleware.ts   # Verificação de autenticação
    error.middleware.ts  # Tratamento de erros

  validators/          # Validação de dados de entrada (Zod, Joi, etc.)
    user.validator.ts    # Ex.: validação de criação/edição de usuário
    
  jobs/                # Processamento em background (Filas com BullMQ)

  lib/                 # Bibliotecas (Queue, Email, etc.)

  utils/               # Funções utilitárias/auxiliares
    logger.ts          # Log centralizado
    hashPassword.ts    # Função para hash de senhas

  app.ts               # Configuração principal do Express (Middlewares, Rotas)
  server.ts            # Ponto de entrada da aplicação (Inicializa o servidor)

🔄 Diagrama do Banco de Dados

classDiagram
    class event {
        string id PK
        string name
        DateTime date_start
        DateTime date_end
        int capacity
        string description
        event_status status
        bool is_visible
    }

    class sector {
        string id PK
        string name
        string description
        Decimal price
        int capacity
        Decimal service_charge
        string event_id FK
    }

    class user {
        string id PK
        string name
        string email
        string password
        string telephone
        type_user type_user
    }

    class ticket {
        string id PK
        string code_qr
        string sale_id FK
        string sector_id FK
        status_ticket status
    }

    class artist {
        string id PK
        string name
        string description
        string contact
    }

    class coupons {
        string id PK
        string code 
        type_coupons type
        Decimal price
        DateTime expiration_date
        int usage_limit
    }

    class sale {
        string id PK
        string user_id FK
        string event_id FK
        string coupon_id FK
        DateTime sale_date
        Decimal price_total
        payment_method payment_method
        status_payment status_payment
    }

    class event_artist {
        string event_id FK
        string artist_id FK
    }

   
    event "1" --* "many" sector
    event "1" --* "many" sale
    user "1" --* "many" sale
    sector "1" --* "many" ticket
    sale "1" --* "many" ticket
    sale "many" o-- "1" coupons
    
    event "1" --* "many" event_artist
    artist "1" --* "many" event_artist

Loading

🧪 Testes

Para garantir a qualidade e o funcionamento da API, execute os testes:

# Executar todos os testes
npm test

# Executar testes unitários
npm test test/unit

# Executar testes de integração
npm test test/integration

🛠️ Tecnologias

• Node.js + Express
• MySQL
• Redis
• Docker
• Prisma ORM
• BullMQ
• Jest
• Swagger

👥 Contribuidores

• Levy Sousa
• Iasmin Oliveira

🤝 Suporte

Para dúvidas ou problemas, abra uma issue no repositório.