Projeto Capadura - Repo Back-end

O projeto foi dividido em dois repositórios, sendo esse aqui para o back-end. Para acessar o repositório do front-end, clique aqui.

Introdução

Capadura é uma ferramenta onde os leitores podem compartilhar avaliações de livros, fazer comentários durante a leitura e descobrir novos livros.

🤖 Tech stack

• Typescript
• Node.js
• Fastify
• Prisma ORM
• AWS S3
• AWS Cloudfront
• Redis
• PostgreSQL

💻 Principais funcionalidades

Sistema

• Registro de usuário
• Sistema de autenticação com e-mail/senha
• Sistema de autenticação com Google OAuth
• Autenticação com JWT

Livros

• Criar livro
• Editar livro
• Listagem dos dados do livro

Leitura

• Criar leitura de livro
• Editar leitura de livro
• Deletar leitura de livro
• Criar progresso de leitura
• Editar progresso de leitura
• Deletar progresso de leitura
• Listagem de todos os progressos de uma leitura
• Listagem de leituras finalizadas do usuário
• Listagem da quantidade de leituras finalizadas por livro
• Listagem da quantidade de páginas lidas por dia do usuário

Avaliação de livros

• Adicionar avaliação de livro
• Editar avaliação de livro
• Listagem da quantidade de avaliações por nota do livro
• Listagem da quantidade de avaliações por nota do usuário

Livros favoritos

• Adicionar livros favoritos do usuário
• Remover livros favoritos do usuário
• Listagem de livros favoritos por usuário

Lista de livros

• Criar/editar/deletar de lista de livros
• Adicionar/deletar livro na lista
• Remover livro da lista
• Listagem das listas do usuário
• Listagem dos livros de uma lista do usuário

Curtidas

• Curtir livro
• Descurtir livro
• Listagem de livros curtidos por usuário
• Total de curtidas por livro

Perfil

• Rota para trazer os dados do usuário por id/nome de usuário
• Editar informações do perfil do usuário

Seguidores/seguindo

• Seguir usuários
• Desseguir usuários
• Rota para saber se o usuário atual segue o perfil que está vendo
• Rota para saber se o usuário atual é seguido pelo perfil que está vendo
• Listagem de quem o usuário segue/é seguido
• Contagem de quantos o usuário segue/é seguido

Atividades recentes do usuário

• Criar e listar as últimas atividades do usuário
  • Curtir livro
  • Iniciar/pausar/retomar leitura
  • Adicionar progresso de leitura
  • Avaliação de livro

🌏 Contribuições

Para quem deseja contribuir: recomendo abrir uma discussão com a alteração que deseja fazer por meio de uma issue, ou uma discussão ou fale comigo diretamente. Estarei aberto para novas implementações ou sugestões :)

Implementações desejadas para o futuro

• Isolar a camada de DTO
• Isolar a camada de entidades
• Testes unitário/integração e e2e em toda a aplicação
• Documentação das rotas

⚙️ Variaveis de ambiente

Caso precise fazer upload de imagens, as variáveis da S3 e do Cloudfront devem ser preenchidas com as respectivas chaves.

S3_BUCKET_NAME=
S3_BUCKET_REGION=
S3_ACCESS_KEY=
S3_SECRET_ACCESS_KEY=

CLOUDFRONT_BASE_URL=
CLOUDFRONT_DISTRIBUTION_ID=
CLOUDFRONT_PRIVATE_KEY=
CLOUDFRONT_KEY_PAIR_ID

Caso precise fazer login através do OAuth com Google, a variável GOOGLE_CLIENT_ID e GOOGLE_SECRET_ID deverão ser criadas através do serviço de OAuth do Google e inseridas manualmente.

🗒️ Licença

MIT © Vinicius Eidy Okuda