iCorrespondência API

🚧 Projeto em construção 🚧

Tabela de conteúdos

• Sobre
• Documentos do projeto
• DevOps
• Protótipo IOT
• Funcionalidades
• Como executar
  • Pré-requisitos
    • Preparando o ambiente
    • Executando a aplicação
• Como contribuir
• Autores
• Licença

Sobre

iCorrespondência trata-se de um projeto voltado para o controle de correspondências de pequeno porte.

Projeto desenvolvido para a Challenge 2021 proposta pela instituição FIAP - Faculdade de Informática e Administração Paulista em parceria com a Plusoft.

Documentos do projeto

Os documentos do projeto: Escopo, Modelagem de dados dentre outros poderão ser encontrados aqui.

⚠️ Ao todo possuem quatro sprints para a realização desse projeto em 2021. A documentação final será disponibilizada em formato de PDF no mesmo diretório.

DevOps

A seção de DevOps e o vídeo de demonstração podem ser encontrados aqui.

Protótipo

O protótipo para a terceira sprint pode ser encontrado em: https://youtu.be/O7JwXDZwrSQ

Funcionalidades

⚠️ Ainda em desenvolvimento

• Usuários: endpoint principal de cadastro de usuários da aplicação, são divididos em:
  • Admin: visão de administrador do condomínio;
  • User: visão de morador do condomínio;
• Correspondências: os moradores poderão ver informações de suas correspondências e acompanhar por um dashboard na aplicação mobile
• Condomínios: endpoint principal de cadastro de condomínios associados
  • possui um dashboard mobile com dados resumidos das correspondências (totalizador)
  • visualização de detalhes de blocos e apartamentos cadastrados;

Como executar

Este projeto concentra todo o backend, podendo ser encontrado no seguinte diretório: src/main/java

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:

• Git: para clonar o repositório em sua máquina;
• Java Development Kit (JDK): para conseguir compilar e executar o projeto;
• PostgreSQL: banco de dados relacional, responsável por armazenar todas as informações do sistema;
• Visual Studio Code: Editor de código utilizada para desenvolver este projeto ou qualquer outro de sua preferência
• Insomnia: Para realizar os testes da API enviando as requisições ou qualquer outro utilitário de sua preferência.

Preparando o ambiente

Após instalar e configurar as ferramentas de sua preferência, ao executar a aplicação pela primeira vez, será criada a estrutura de tabelas necessárias.

⚠️ É necessário que a base de dados tenha sido criada previamente.

⚠️ Para que a aplicação consiga acessar a base de dados, edite o arquivo .env.template ou exporte as variáveis de ambiente no seu sistema operacional conforme detalhes em arquivo.

Executando a aplicação

• Clone este repositório

  • HTTPS:

  git clone https://github.com/ozluuh/icorrespondencia-api.git

  ou

  • SSH:

  git clone [email protected]:ozluuh/icorrespondencia-api.git

• Abra no editor de código de sua escolha;

• Abra o arquivo ApiApplication.java e execute pelo editor de código ou pelo terminal com:

  cd icorrespondencia-api
  
  mvn spring-boot:run

• Abra o Insomnia e crie uma requisição do tipo GET apontando para o seguinte endereço http://localhost:8080/api/test;

• Por fim, realize os testes 😄

Como contribuir

1. Faça o fork do projeto;
2. Realize as alterações e envie um pull request.

Autores

Nome	RM	Função	Social
Daiane Estenio	84198	Project manager
Denis Mantovani	86225
Lucas Oliveira	85142	Software architect
Luís Paulino	85398	Fullstack Developer

Licença

MIT © 21 Things