O projeto consiste no desenvolvimento de um sistema integrado para a gestão financeira do programa de assistência estudantil de alunos do Instituto Federal de Pernambuco (IFPE), com funcionalidades para auxiliar nesse processo provendo análise de aptidão dos alunos inscritos, acompanhamento de pagamentos de bolsas estudantis e notificações automáticas, conectando alunos, setor financeiro e setor de assistência social em um único sistema. A principal funcionalidade será a integração entre esses três atores em um sistema que possibilita gerenciar algumas etapas estratégicas do fluxo de assistência estudantil e informar, de forma transparente e acessível a todos os atores, o acompanhamento financeiro relacionado à concessão de bolsas estudantis. Atualmente em torno de 60% a 65% dos alunos do IFPE são identificados como vulneráveis econômicos e sociais.

Com base nisso, o projeto visa resolvê-los por meio de uma solução que apresente:

• Integração e automação
• Transparência no processo
• Comunicação entre os atores
• Pré-classificação dois alunos aptos

Com essa abordagem, o projeto se alinha na melhora da experiência dos alunos que necessitam das bolsas e também na eficiência administrativa.

Atualmente, esse projeto é composto por 4 repositórios, cada um com sua responsabilidade:

• Conecta IFPE - Frontend: É esse repositório, responsável pela interface do usuário e pela documentação geral do projeto.

• Conecta IFPE - Backend: API Gateway reponsável pela centralização, controle e monitoramento das requisições. Além de ser responsável pelo gerenciamento de Autenticação e Autorização.

• Conecta IFPE - Rank IA: Microserviço responsável por fazer o ranqueamento dos alunos com base em dados históricos.

• Conecta IFPE - Financeiro: Microserviço responsável por gerar e gerenciar os pagamentos das bolsas estudantis.

Além disso, temos o Figma com o design do projeto.

Para iniciar o projeto, siga estes passos:

1. Faça um fork e clone o repositório:

git clone https://github.com/Dev-JoseRonaldo/conecta-ifpe.git

2. Instale as dependências:

yarn install --frozen-lockfile

3. Execute o servidor de desenvolvimento:

yarn dev

4. Acesse http://localhost:3000 no seu navegador para ver o resultado.

5. Este projeto usa um git hook para garantir conventional commits. Para instalar o git hook, execute o seguinte comando no diretório raiz do projeto:

brew install pre-commit
pre-commit install -t commit-msg

Para rodar o projeto você precisará dos seguintes pré-requisitos de instalação:

1. Node.js: Certifique-se de ter a versão mais recente do Node.js instalada, preferencialmente LTS, pois muitas dessas ferramentas dependem do ambiente Node.js para funcionar.

2. NPM ou Yarn: Gerenciadores de pacotes como NPM (vem com o Node.js) ou Yarn são necessários para instalar as dependências do projeto.

3. Git: Para gerenciar o controle de versão, clonar repositórios e utilizar GitHub Actions, é necessário ter o Git instalado.

4. Docker (opcional, mas recomendado): Se você for usar Kubernetes, o Docker será útil para criar e gerenciar contêineres durante o desenvolvimento e teste.

Toda a documentação necessária para o projeto, incluindo guias de instalação, configuração, e uso das ferramentas, pode ser encontrada na pasta docs localizada na raiz do projeto. Certifique-se de revisar esses documentos para obter orientações detalhadas sobre o desenvolvimento e manutenção do projeto.

Contribuições são sempre bem-vindas, veja como você pode ajudar:

1. Crie um fork a partir do nosso projeto, isso criará um novo repositório em sua conta.
2. No seu repositório, crie uma branch a partir da branch main, esta branch deve ser nomeada de acordo com sua contribuição.
3. Faça suas contribuições nesta branch.
4. Abra um Pull Request do seu repositório para o nosso, enviando esta branch com sua contribuição, a branch de destino deve ser a main.

Leia através do CONTRIBUTING

Este projeto está licenciado sob a Licença MIT - veja o arquivo LICENSE para detalhes.

Este projeto está em desenvolvimento ativo. Você pode esperar mudanças frequentes e atualizações.

Luiz Henrique AI Engineer / Pentester Linkedin	José Ronaldo FullStack Developer Linkedin	Karen Verçosa UI/UX Design Linkedin	Vitória Beatriz UI/UX Design Linkedin