Skip to content

Instantly share code, notes, and snippets.

@luanalessa
Last active February 1, 2024 13:09
Show Gist options
  • Save luanalessa/7f98467a5ed62d00dcbde67d4556a1e4 to your computer and use it in GitHub Desktop.
Save luanalessa/7f98467a5ed62d00dcbde67d4556a1e4 to your computer and use it in GitHub Desktop.
Exemplo de documentação para projetos

Projeto X

📋 Descrição

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla urna massa, mollis id facilisis ut, tristique convallis dolor. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Maecenas a egestas sapien, lacinia iaculis nisi. Nam molestie fringilla egestas. Vestibulum pulvinar consequat arcu a varius. Vestibulum nec finibus enim. In at lobortis elit. Mauris imperdiet neque quis imperdiet ornare. Maecenas non nulla orci. Vestibulum tempor vitae tortor eget lobortis. Integer sapien eros, condimentum sit amet est at, vulputate efficitur elit. Praesent in velit pharetra, commodo libero a, egestas leo. Sed nunc enim, sodales vel pretium at, sodales a magna. Mauris nec nibh at enim venenatis faucibus. Duis bibendum commodo mattis. Phasellus luctus felis varius porta lacinia.


💻 Tecnologias e Conceitos

  • REST APIs
  • JWTs & refresh tokens
  • Node.js
  • TypeScript
  • MongoDB with Mongoose

🚀 Rotas

POST /cadastro
    - Rota para cadastrar um novo usuário
    - headers: {}
    - body:{
        "nome": "Lorem ipsum",
        "email": "lorem@gmail.com",
        "senha": "loremipsum"
}
POST /login
    - Rota para fazer login
    - headers: {}
    - body: {
    "email": "lorem@gmail.com",
    "senha": "loremipsum"
    }
GET /usuarios (autenticada)
    - Rota para listar todos os usuários
    - headers: { "Authorization": "Bearer $token" }
    - body: {}
GET /usuarios/:id (autenticada)
    - Rota para listar um usuário pelo id
    - headers: { "Authorization": "Bearer $token" }
    - body: {}
PUT /usuarios/:id (autenticada)
    - Rota para atualizar um usuário pelo id
    - headers: { "Authorization": "Bearer $token" }
    - body: {
        "nome": "Lorem ipsum2",
        "email": "lorem2@gmail.com",
        "senha": "loremipsum2"
    }
DELETE /usuarios/:id (autenticada)
    - Rota para deletar um usuário pelo id
    - headers: { "Authorization": "Bearer $token" }
    - body: {}

🏁 Rodando a aplicação

Este projeto foi inicializado com o Create React App, então certifique-se que voce tem a ultima versão estável do Node.js e npm rodando localmente.

Primeiro, faça o clone desse repositório na sua maquina:

git clone https://github.com/luanalessa/projeto-backend.git

Depois, dentro da pasta, rode o seguinte comando para instalar as dependencias.

npm install

Finalizado o processo, é só inicializar o servidor

npm start

🛑 Não esqueça de repetir os passos acima com o repositório que contem a interface da aplicação, para testar o projeto por completo.

@duongchiluon
Copy link

Verify Github on Galxe. gid:LUkzPT7mUyDCkvq79mnz6d

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment