Neo-Brasil-Documentacao

:pencil: Sobre o projeto

O projeto tem como objetivo o desenvolvimento de um software para gestão de cobranças, onde nesse é necessário que se permita o cadastro de clientes, o registro de cobranças das parcelas a receber e dos pagamentos efetuados, além da geração de relatórios de cobrança com diferentes tipos de busca por data e situação das parcelas.

• Repositório Backend: https://github.com/Neo-Brasil/Neo-Brasil-Backend

• Repositório Frontend: https://github.com/Neo-Brasil/Neo-Brasil-Frontend

• Repositório Documentação: https://github.com/Neo-Brasil/Neo-Brasil-Documentacao

🏁 Entregas de Sprints

Sprint	Previsão	Status	Relatório	Tag
01	13/03/2023 à 02/04/2023	Finalizado ✔️	Ver relatório	1.0.0
02	03/04/2023 à 23/04/2023	Finalizado ✔️	Ver relatório	2.0.0
03	24/04/2023 à 14/05/2023	Finalizado ✔️	Ver relatório	3.0.0
04	15/05/2023 à 04/06/2023	Finalizado ✔️	Ver relatório	4.0.0

:pushpin: Backlog do Produto

Épicos (Requisitos Funcionais)

SPRINT	CÓDIGO	DESCRIÇÃO	STATUS
1	RF1	Crud de clientes e titulos	✅
1	RF2	Registro de pagamentos	✅
1	RF3	Relatório de entrada (fluxo de caixa)	✅
1	RF4	Login de administrador	✅
2	RF5	Geração de parcelas	✅
2	RF6	Crud de usuários	✅
2	RF7	Login por setores	✅
2	RF8	Filtro por intervalos de tempo	✅
3	RF9	Filtro por tipos de datas (pagamento, vencimento ou crédito)	✅
3	RF10	Melhorias nas funcionalidades do sistema	✅
4	RF11	Organização do relatório por parcelas	✅
4	RF12	Adicionar mais de um título por cliente	✅

Requisitos Não Funcionais

CÓDIGO	DESCRIÇÃO
RNF1	Java
RNF2	TypeScript
RNF3	BPMN
RNF4	Documentação com mapeamento das regras de negócio do cliente

CÓDIGO	DESCRIÇÃO
TD1	Banco de Dados Relacional (MySQL)

Voltar ao menu

:file_folder: Configuração das pastas

• 📂 doc: onde estão armazenados a pasta data_base, com o modelo do banco de dados, a pasta bpmn, com o modelo BPMN, as pastas sprint_2, sprint_3 e sprint_4, armazenando os relatórios das sprints, e o arquivo manual_usuario.

:scroll: Manual de instalação e utilização

• Depois de instalar as tecnologias necessárias para o projeto(NodeJS, MySql, MySQL Workbench, Java, Eclipse e Spring) digite no cmd:

  git clone https://github.com/Neo-Brasil/Neo-Brasil-Documentacao
  cd Neo-Brasil-Documentacao
  git submodule update --init
  cd Neo-Brasil-Backend/neobrasil-backend
  

• Abra a pasta neobrasil-backend e configure os dados do seu banco de dados nos arquivos AplicacaoApplication e Application.properties

  

  

• Execute os seguintes comandos no MySQL Workbench:

  

• Execute o arquivo AplicacaoAplication.java

• Após executar o backend, retorne para pasta Neo-Brasil-Documentacao, execute os comandos seguintes no cmd e leia o manual de utilização:

  cd Neo-Brasil-Frontend
  npm install
  npm start
  

  Voltar ao menu

:busts_in_silhouette: Equipe

Função	Nome	LinkedIn & GitHub
Scrum Master	Júlia Sousa Gayotto
Product Owner	Carlos Eduardo Falandes
Dev Team	Amanda Vieira de Oliveira
Dev Team	Lucas França Registro

Voltar ao menu