Boas vindas ao repositório do Chat API

API de comunicação entre usuários em tempo real! Chat API foi desenvolvida em Node.js com express, Typescript, POO, socket.io para implementar a emissão e escuta de eventos entre usuários, e JWT para autenticação. O projeto conta também com alguns endpoints e com integração com um banco de dados não relacional - MongoDB. A arquitetura da aplicação foi feita em camadas utilizando o padrão MSC: model, service e controller.

Como as informações dos usuários são salvas no banco de dados, neste projeto, foi utilizada a biblioteca de criptografia MD5 que criptografa a senha antes de ser armazenada no banco de dados.

O deploy da API foi feito através do Heroku utilizando Docker. E sua versão em produção pode ser acessada por este Link

Endpoints usados

• Registro:

  • Método: POST,

  • Rota: /users

  • Resposta:

    

• Login:

  • Método: POST,

  • Rota: /users/login

  • Resposta:

    

• Nova Mensagem:

  • Método: POST,

  • Rota: /messages,

  • Resposta:

    

• Mensagens por Sala:

  • Método: GET,

  • Rota: /messages/:roomId,

  • Resposta:

    

• Salas:

  • Método: GET,

  • Rota: /rooms,

  • Resposta:

    

Tecnologias Usadas

• Node.js
• Express
• Typescript
• socket.io
• MongoDB
• Mongoose

Rodando localmente

Observação:

Para fazer conexão com o banco de dados, você precisa ter o MongoDB instalado na sua máquina

Instruções:

• Faça o clone do repositório.
• Utilize o comando yarn para instalar as dependências do projeto.
• Troque o nome do arquivo ".env.example" para ".env".
• Rode o comando yarn start para iniciar a aplicação.