Este repositório contém o código da aplicação Acessibilidade Urbana, desenvolvida pelo grupo Honolulu da disciplina MC536 – Banco de Dados: Teoria e Prática, do Instituto de Computação da UNICAMP. O objetivo da aplicação é oferecer suporte à locomoção de pessoas com deficiência e/ou necessidades especiais, permitindo a consulta e avaliação de estabelecimentos acessíveis na cidade além da criação de avisos de acessibilidade pela cidade.
- Descrição da Aplicação
- Estrutura do Repositório
- Tecnologias Utilizadas
- Como Executar a Aplicação
- Arquitetura e Funcionalidades
- Contribuindo
- Licença
A Navable é uma aplicação que tem como principal objetivo facilitar a locomoção e a busca por locais acessíveis para pessoas com deficiência ou necessidades especiais. A aplicação permite que os usuários:
- Se cadastrem no sistema e escolham suas necessidades de acessibilidade.
- Avaliem estabelecimentos e ocorrências de acessibilidade em diferentes locais.
- Consultem um mapa interativo de estabelecimentos acessíveis, com filtros baseados nas necessidades individuais do usuário.
- Registrem e acompanhem ocorrências relacionadas à acessibilidade em espaços públicos e privados.
O sistema é composto por um frontend que interage com a API backend para acessar e manipular os dados no banco de dados. A aplicação permite a personalização da experiência, com base nas necessidades de acessibilidade do usuário, garantindo uma experiência inclusiva.
Este repositório está organizado da seguinte forma:
- docker/: Contém arquivos de configuração para rodar a aplicação em containers Docker.
- navable/: Diretório que contém o código do frontend, que é responsável pela interface de usuário (UI) e interação com a API.
- navable-api/: Diretório que contém o código do backend (API), que gerencia as requisições e interage com o banco de dados.
- Diagrama em nível de componentes (C4 - Nível 3) para a arquitetura do projeto: https://drive.google.com/drive/folders/17x3mZ-DcIVnIoU82DQ-MqkFcYDOdCPEi?usp=drive_link
- O backend utiliza uma variação da arquitetura MVC, isolando a lógica de domínio das interações externas.
- Os Controllers atuam como a camada de entrada, enquanto os Repositories funcionam como a camada de saída.
- Entre elas temos os services, que encapsulam a lógica de negócios central, independente de infraestrutura externa.
- Implementado explicitamente no backend, abstraindo o acesso aos dados e permitindo a troca de tecnologias de persistência sem afetar a lógica de negócios.
- Repositories expõem interfaces de alto nível para manipular as entidades, ocultando detalhes da implementação do banco de dados.
- Utilizado extensivamente no Spring Boot para gerenciar dependências entre componentes.
- Facilita testes unitários e melhora a modularidade, permitindo substituir implementações conforme necessário.
- Orquestra operações complexas que envolvem múltiplos repositórios e regras de negócios.
- Centraliza a lógica de domínio, aplicando validações e regras de negócio antes de persistir dados.
- Os Controllers da API funcionam como fachadas, simplificando o acesso aos serviços do backend.
- Expõem uma interface REST coerente que oculta a complexidade interna do sistema.
- Implementado para gerenciamento de estado e injeção de dependências no frontend.
- Permite compartilhar dados entre widgets e gerenciar o ciclo de vida dos componentes.
- UI Components: Componentes de interface reutilizáveis como botões, cards e elementos de formulário adaptados para acessibilidade.
- Pages: Telas da aplicação que organizam os componentes de UI e conectam-se aos controllers, implementando layouts específicos para cada funcionalidade.
- Controllers: Responsáveis pela lógica de apresentação, gerenciamento do estado da UI e tratamento de eventos do usuário.
- Services: Lidam com a lógica de negócios do cliente e comunicação com a API, processando e transformando dados.
- Data Transfer Objects (DTO): Estruturas de dados para comunicação entre camadas e serialização/deserialização de JSON.
- HTTP Client: Responsável pela comunicação com o backend através de requisições HTTP, gerenciando erros e retentativas.
- REST API Controllers: Expõem endpoints da API, validam entradas e direcionam requisições para os serviços apropriados.
- Service Layer: Contém a lógica de negócios, orquestrando operações e garantindo a integridade dos dados entre diferentes entidades.
- Repository Layer: Provê abstração para acesso ao banco de dados e implementa operações CRUD específicas para cada domínio.
- Entity Models: Representam as entidades do domínio e são mapeadas para tabelas do banco de dados através de JPA/Hibernate.
- JPA/Hibernate: Framework ORM para mapeamento objeto-relacional e abstração do acesso ao banco de dados.
- Gerencia o ciclo de vida dos usuários (cadastro, autenticação, recuperação e exclusão)
- Mantém perfis com necessidades específicas de acessibilidade
- Controla a gamificação (selos por contribuições)
- Armazena preferências e configurações personalizadas
- Gerencia relações com avaliações e ocorrências criadas pelo usuário
- Registra problemas de acessibilidade com geolocalização
- Permite categorização por tipos de barreiras
- Implementa sistema de votos para priorização
- Fornece consultas baseadas em proximidade geográfica
- Mantém status de resolução e histórico de atualizações
- Armazena informações de locais com suas coordenadas geográficas
- Categoriza estabelecimentos por tipo e serviços oferecidos
- Calcula e mantém métricas de acessibilidade baseadas em avaliações
- Permite buscas por proximidade e filtros por recursos de acessibilidade
- Vincula-se às ocorrências registradas no local
- Registra feedback dos usuários sobre estabelecimentos
- Utiliza sistema de pontuação para diferentes aspectos de acessibilidade
- Permite comentários detalhados e upload de imagens
- Fornece mecanismos de moderação e denúncia
- Calcula métricas consolidadas de acessibilidade
-
Frontend:
- Flutter.
- Comunicação com a API via HTTP (REST).
-
Backend:
- Java (utilizando Spring Boot e JPA).
- RESTful API
-
Docker:
- Contêineres para a subida do banco de dados Postgres.
- Docker: Certifique-se de que o Docker esteja instalado na sua máquina. Instruções de instalação do Docker.
- Java: Tenha Java 21 para manipular diretamente o back-end Refira-se ao README de /navable-api para mais informações.
- Maven: Refira-se ao README de /navable-api para mais informações.
- Flutter SDK: Flutter é necessário para a execução do projeto Refira-se ao README de /navable para mais informações.
-
Clone o repositório:
git clone https://github.com/edumigueis/Navable.git cd Navable -
Inicie o container docker com o banco de dados:
cd ./docker docker compose up -
Siga os passos no readme de cada pasta para configurar e iniciar o back-end e o front-end
O frontend da aplicação é responsável por:
- Exibir os dados de estabelecimentos e ocorrências acessíveis em um mapa interativo.
- Permitir que os usuários filtrem e busquem informações com base em suas necessidades de acessibilidade.
- Fornecer uma interface intuitiva para o cadastro de usuários, registro de avaliações e inserção de ocorrências.
- Ainda carece de algumas implementações que excederam o tamanho do escopo.
O backend é responsável por:
- Processar as requisições da aplicação frontend.
- Validar e persistir dados no banco de dados.
- Garantir que as regras de negócio sejam seguidas, como validação de avaliações e controle de integridade dos dados.
As operações no banco de dados são feitas através de SQL, com o arquivo init.sql fornecendo dados iniciais.
Se você gostaria de contribuir com melhorias ou correções, siga os passos abaixo:
- Faça um fork deste repositório.
- Crie uma nova branch para sua feature ou correção:
git checkout -b minha-feature- Realize as modificações necessárias.
- Envie as mudanças para o repositório:
git push origin minha-feature- Abra um pull request para revisão.
Este projeto não é licenciado, peça autorização para utilizá-lo por completo.