Skip to content

Kauan-13/tohth

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

216 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Projeto Tohth: Totem de avaliação

Propósito do Projeto

Possibilitar que bibliotecas possam apresentar aos seus leitores um sistema para a avalição dos livros que existem naquela biblioteca. Dessa forma os leitores que participam daquela comunidade possam consultar as avaliações de outros leitores e opinar sobre as suas leituras fortalecendo a comunidade local.

Objetivos:

Principal

  • Entregar um sistema de avalição.

Especificos

  • Um sistema de avalições para a biblioteca do IFSC e de São José.

Justificativa

O indice de leitura do Brasil é baixo, então é importante o desenvolvimento de ferramentas que incentivem a leitura.

Benefícios

Auxiliar as pessoas a selecionar próximas leituras por meio de avalições de outros usuários, e ao mesmo tempo fortalecendo a comunidade leitora do local onde o sistema for implementado.

Equipe do Projeto

Time:

  • Kauan Oliveira Freitas
  • Thays da Silva Mariano

Estrutura do Projeto

Este projeto é dividido em dois módulos:

  • Backend: API REST em Spring Boot, executada via Docker Compose.
  • Frontend: Aplicação React (Vite) executada separadamente em ambiente local.
/projeto-tohth
│
├── tohth-api           # Backend Spring Boot
├── tohth               # Frontend React (Vite)
└── docker-compose.yml

Pré-requisitos

Você precisa ter instalado na sua máquina:

  • Docker
  • Docker Compose
  • Node.js (versão 18 ou superior recomendada)
  • npm

Como rodar o Backend (Docker + Spring Boot)

1. Abra o terminal na raiz do projeto

Onde está localizado o arquivo:

docker-compose.yml

2. Suba o container do backend

docker compose up --build

Isso vai:

  • Buildar a imagem do Spring Boot
  • Subir o container da API

Por padrão, a API estará em:

http://localhost:8080

Documentação da API (Swagger)

Para visualizar o Swagger, após executar o docker acesse:

http://localhost:8080/swagger-ui.html

Autenticação (Pendente)

A implementação da autenticação está sendo desenvolvida em uma branch separada, chamada feat/autenticacao. Essa funcionalidade não foi concluida a tempo da entrega mas o diagrama de arquitetura já demonstra a estrutura e o fluxo de dados previstos para a implementação.

Como rodar o Frontend (React + Vite)

Abra outro terminal separado.

1. Entre na pasta do frontend

cd tohth

2. Instale as dependências

npm ci

3. Rode a aplicação

npm run dev

O frontend estará disponível em:

http://localhost:5173

Para acessar a página de um livro (mockado) acesse:

http://localhost:5173/bookPage

Implementações do Frontend

O frontend já implementa os endpoints /tag, /biblioteca, e /avaliacao. Sendo assim, permite a criação de uma avaliação completa no banco de dados.

Acessando o Banco de Dados

Para acessar diretamente o Banco de Dados rode os comandos em outro terminal:

# Entra no banco
docker exec -it postgres-db psql -U user -d mydb    

# Exibe as tabelas
\dt                                                 

# Exibe os dados
select * from <tabela>;                              

Histórico do documento

  • 18/08/2025: Primeira versão.
  • 19/08/2025: Segunda versão.
  • 25/11/2025: Terceira versão.

About

Um sistema para avaliação de livros

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors