mtsgamorim / Bookers-Club-Back-End

This is my personal project. It is about reviewing and checking books and also looking for synopses.

Projeto Bookers Club

📋 Descrição

Bookers Club é uma aplicação onde cada usúario pode ter um histórico de todos os livros que já leu, encontrar qualquer livro e ler reviews de outros usúarios para poder decidir qual será a sua próxima leitura

---

💻 Tecnologias e Conceitos

• Typescript
• Postgres with Prisma
• Jest and Supertest
• Express

---

🚀 Rotas

POST /sign-up
    - Rota para cadastrar um novo usuário
    - headers: {}
    - body:{
        "name": "Lorem ipsum",
        "email": "[e-mail]",
        "image": "https://lorem.com"
        "password": "loremipsum"
}

POST /sign-in
    - Rota para fazer login
    - headers: {}
    - body: {
    "email": "[e-mail]",
    "password": "loremipsum"
    }

Post /book (autenticada)
    - Rota para criar um livro ja lido
    - headers: { "Authorization": "Bearer $token" }
    - body: {
                "bookId": "FDSDFAF",
                "title": "livro"
            }

GET /book (autenticada)
    - Rota para listar livros do usuario
    - headers: { "Authorization": "Bearer $token" }
    - body: {}

GET /book/:id (autenticada)
    - Rota para visualizar livro especifico do usuario (id é o bookId)
    - headers: { "Authorization": "Bearer $token" }
    - body: {}

PATCH /book/:id (autenticada)
    - Rota para adicionar review em um livro
    - headers: { "Authorization": "Bearer $token" }
    - body: {
        review: "sua review"
    }

DELETE /book/:id (autenticada)
    - Rota para remover livro lido
    - headers: { "Authorization": "Bearer $token" }
    - body: {}

GET /reviews (autenticada)
    - Rota para ver os reviews de outros úsuarios
    - headers: { "Authorization": "Bearer $token" }
    - body: {}

---

🏁 Rodando a aplicação

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

git clone https://github.com/mtsgamorim/Bookers-Club-Back-End

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

npm install

Finalizado o processo, é só inicializar o servidor

npm run dev

🛑 Não esqueça de visualizar o front-end dessa aplicação: repositório que contem a interface da aplicação, para testar o projeto por completo.