Skip to content

Latest commit

 

History

History
237 lines (169 loc) · 4.69 KB

README.pt-br.md

File metadata and controls

237 lines (169 loc) · 4.69 KB
Raw


Chatty

Sobre • Tecnologias • Como executar • Endpoints • Documentação • Autores • Licença

ℹ️ Sobre o projeto

Chat com Socket.IO criado na RocketSeat Next Level Week 5.0, usando TypeScript com Node.js.

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

🚀 Como executar o projeto

👉 Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js and Yarn. Além disto é bom ter um editor para trabalhar com o código como VSCode.

🏁 Começar

# Clone este repositório
$ git clone https://github.com/BiaChacon/chatty.git

# Acesse a pasta do projeto no terminal/cmd
$ cd chatty

🎲 Executando o servidor

# Vá para a pasta da api
$ cd api

# Instale as dependências
$ npm install

# Criar migrations
$ yarn typeorm migration:run

# Execute a aplicação
$ yarn dev

# O servidor iniciará na porta:3333 - acesse http://localhost:3333

🖥️ Endpoints

💠 Para acessar o chat do admin vá para 👉 http://localhost:3333/pages/admin

💠 Para acessar o chat do cliente vá para 👉 http://localhost:3333/pages/client

🗎 Documentação API

Configurações

📍 Criar Configuração [/settings] [POST]

Request

  • Body
{
    "chat": "true",
    "username": "admin"
}

Response 201 (application/json)

[
  {
    "id": "admin_id",
    "username": "admin",
    "chat": "true",
    "updated_at": "2021-04-22T19:22:37.000Z",
    "created_at": "2021-04-22T19:22:37.000Z"
}
]

📍 Atualizar Configuração [/settings/admin] [PUT]

Request

  • Body
{
    "chat": "false"
}

Response 201

Usuário

📍Criar Usuário [/users] [POST]

Request

  • Body
{
    "email": "example@email.com"
}

Response 201 (application/json)

[
 {
    "id": "user_id",
    "email": "example@email.com",
    "created_at": "2021-04-22T19:37:24.000Z"
}
]
Mensagem

📍Enviar Mensagem [/messages] [POST]

Request

  • Body
{
    "user_id": "user_id",
    "text": "message"
}

Response 201 (application/json)

[
  {
    "id": "message_id",
    "text": "message",
    "user_id": "user_id",
    "created_at": "2021-04-23T19:40:02.000Z"
  }
]

📍Listar mensagens de um usuário [/messages/:user_id] [GET]

Response 201 (application/json)

[
  {
    "id": "message_id",
    "admin_id": "admin_id",
    "text": "message",
    "user_id": "user_id",
    "created_at": "2021-04-22T19:40:02.000Z",
    "user": {
      "id": "user_id",
      "email": "example@email.com",
      "created_at": "2021-04-22T19:37:24.000Z"
    }
  }
]

👩🏽‍💻 Autores


Bia Chacon
💻

📝 Licença

Este projeto está sob o MIT. Veja aqui LICENSE para mais informações.

Versões do README

Inglês 🇺🇸 | Português 🇧🇷