😎 Back-end da aplicação InfluenceHub

O projeto InfluenceHub consiste em uma API desenvolvida para simplificar a gestão de influenciadores e marcas. Com recursos que permitem criar, visualizar, atualizar e relacionar influenciadores e marcas de acordo com categorias, a plataforma visa aumentar a produtividade e a buscar o influenciador digital adequado para promover sua marca.

Para uma experiência completa, siga o passo-a-passo abaixo para iniciar o servidor e, depois, inicie a interface front-end para interagir com a API!

Tecnologias

Este projeto utiliza as seguintes tecnologias:

• Node.js com framework NestJS e TypeScript;

• Prisma ORM para comunicação e manipulação do banco de dados SQLite;

• AWS S3 Bucket: Armazenamento de dados em nuvem;

• Passport.js para implementação de estratégias de autenticação;

• JWT para autenticação e autorização de acesso;

• Bcrypt e Crypto como ferramenta de criptografia;

• Helmet para configuração segura dos cabeçalhos HTTP;

• CORS para controle de acesso à API;

• Docker como uma ferramenta de containerização;

• Jest para execução e automação dos testes unitários;

• Swagger para documentação da API;

Funcionalidades

Autenticação:

• Cadastro, login e logout de administradores.

Gerenciamento de Administradores:

• Listagem, visualização, edição e exclusão de administradores.

Gerenciamento de Influenciadores:

• Cadastro, listagem, visualização e edição de influenciadores.
• Preenchimento automático de endereço usando a API do ViaCEP.
• Filtros avançados para busca de influenciadores por categorias, alcance, cidade.

Gerenciamento de Marcas:

• Cadastro, listagem, visualização e edição de marcas.

Relacionamento Influenciador-Marca:

• Associação de influenciadores a marcas.
• Listagem de influenciadores de determinada marca.
• Identificação de categorias em comum entre influenciadores e marcas.

Configuração do Projeto

Requisitos para rodar a aplicação

• NodeJs (versão 18.x ou superior);
• Docker e Docker Compose;

Instalação

1. Clonando o repositório:

$ git clone git@github.com:rafittu/back-influence-hub.git
$ cd back-influence-hub

2. Crie um arquivo .env na raiz do projeto e preencha as informações de acordo com o arquivo .env.example disponível.

3. Inicie o ambiente de desenvolvimento:

$ docker-compose up --build

Endpoints Principais

Administradores:

• POST /admin/signup: Criar um novo administrador;

  {
    "name": "John Doe",
    "email": "john@doe.com",
    "password": "@Senha123",
    "passwordConfirmation": "@Senha123"
  }
  

• POST /signin: Login de administradores;

  • Corpo da requisição:

  {
    "email": "john@doe.com",
    "password": "@Senha123",
  }
  

  • Resposta:

  {
    "accessToken": "jwt.access.token.2024",
  }
  

  O accessToken retornado na requisição de login deve ser utilizado no campo Authorization no formato Bearer accessToken dentro do cabeçalho Header para futuras operações na plataforma.

• GET /me: Extrair usuário do accessToken enviado no Header da requisição;

    {
      "id": 1,
      "name": "John Doe",
      "email": "john@doe.com"
    }
  

Influenciadores:

• POST /influencer/create: Criar um novo influenciador;

  {
    "name": "Juju do Pix",
    "username": "jupix",
    "email": "judopix@bc.com",
    "niches": ["Artes", "Beleza & Maquiagem"],
    "reach": 150900,
    "photo": "http://example.com/photo.bucket.aws.com",
    "zipCode": "12345-678",
    "street": "Ezequiel Dias",
    "number": "45"
  }
  

• GET /influencer/all: Lista todos os influenciadores;

• GET /influencer/filter: Lista influenciadores por filtros;

  1. Filtros devem ser usados como @Query() nas requisições. Opções disponíveis:
     • reachMin
     • reachMax
     • niche
     • city

• GET /influencer/{id}: Detalhes de um influencer;

• PATCH /influencer/{id}: Editar um influenciador;

• DELETE /influencer/delete/{id}: Exclusão de influenciador;

Marcas:

• POST /brand/create: Criar uma nova marca;

  {
    "name": "M5",
    "description": "boom your style",
    "niches": ["Artes", "Beleza & Maquiagem"]
  }
  

• GET /brand/: Lista todas as marcas;

• GET /brand/:id: Detalhes de uma marca;

    {
    "id": 1,
    "name": "M5",
    "description": "booom your style",
    "niches": [
      "Artes",
      "Beleza & Maquiagem"
    ],
    "createdAt": "2024-08-31T17:33:28.555Z",
    "updatedAt": "2024-08-31T17:34:40.531Z"
    }
  

• PATCH /brand/:id: Editar dados de uma marca;

• DELETE /brand/delete/{id}: Exclusão de marca;

Associações:

• POST /brand/associate-influencer: Associa um influenciador a uma marca e retorna as categorias em comum. O id do influenciador e da marca devem ser passados como @Query() na requisição respectivamente como influencerId e brandId;

  {
    "id": 10,
    "influencerId": 1,
    "brandId": 2,
    "createdAt": "2024-09-01T13:18:53.067Z",
    "updatedAt": "2024-09-01T13:18:53.067Z",
    "influencer": {
      "id": 1,
      "name": "Juju do Pix",
      "username": "jupix",
      "reach": 150900
    },
    "brand": {
      "id": 2,
      "name": "M5",
      "description": "boom your style"
    },
    "commonNiches": [
      "Artes",
      "Beleza & Maquiagem"
    ]
  }
  

• GET /brand/influencers/by-brand: Lista todas os influenciadores de determinada marca. O nome da marca deve ser passado na @Query() da requisição como brand;

• DELETE /brand/disassociate-influencer/: Desassocia marca de influenciadores. O id da marca e do influenciador a ser desassociado devem ser passados na @Query() da requisição;

Testes

A API possui uma cobertura de testes unitários abrangente, com 100% de cobertura em cada parte essencial do código, garantindo a qualidade e o correto funcionamento do sistema.

Para executar os testes unitários, utilize o seguinte comando:

$ npm run test

Você também pode gerar um relatório de cobertura dos testes para verificar quais partes do código foram testadas. Para gerar esse relatório, utilize o seguinte comando:

$ npm run test:cov

Documentação

A documentação completa da API está disponível através do Swagger. Para acessá-la, siga as etapas abaixo:

• Certifique-se de ter a API em execução localmente ou em um ambiente acessível;
• Abra um navegador da web e acesse a seguinte URL: http://localhost:3000/v1/api-doc (substitua 3000 pelo número da porta inserida no arquivo .env);
• A documentação interativa da API será exibida no Swagger UI, onde você poderá explorar todos os endpoints, seus parâmetros e exemplos de solicitação/resposta.

Rafael Ribeiro 🚀