Skip to content

RestAPI do sistema HelpDevas - Backend do sistema que tem como objetivo fazer o registro de aspirantes do vale do amanhecer.

Notifications You must be signed in to change notification settings

ViniciusAndradex/HelpDevas

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 

Repository files navigation

HelpDevas

[Incluir imagem ou logo do projeto aqui]

Índice

Sobre

O HelpDevas é um projeto que visa criar um site responsável por registrar aspirantes à doutrina do Vale do Amanhecer. Esta etapa inicial do projeto se concentra no desenvolvimento do backend, onde toda a lógica por trás da aplicação será implementada.

Este backend será responsável por gerenciar o registro de aspirantes, armazenando informações importantes sobre eles e fornecendo funcionalidades essenciais para a plataforma. Isso inclui autenticação de usuários, manipulação de dados do usuário, integração com bancos de dados e outras tarefas fundamentais para o funcionamento do sistema.

Funcionalidades

  • Login: Os instrutores terão acesso a contas de usuário para realizar os registros dos aspirantes.
  • Cadastro dos Instrutores: Funcionalidade que permite o cadastro dos instrutores responsáveis pela orientação dos aspirantes.
  • Cadastro dos Aspirantes: Permite o registro dos aspirantes à doutrina do Vale do Amanhecer, capturando suas informações pessoais necessárias.
  • Sistema de Aviso para o Responsável: Implementação de um sistema de aviso para o responsável pelo projeto, que poderá receber notificações via e-mail e/ou SMS sobre eventos importantes, como novos registros de aspirantes.
  • Gerador de PDF: Funcionalidade que permite ao administrador/responsável visualizar os registros armazenados e gerar arquivos PDF a partir desses dados. Isso proporciona uma maneira conveniente de documentar e revisar as informações dos aspirantes.

Instalação

[Observação: Esta seção será atualizada no futuro com instruções detalhadas sobre como instalar e configurar o projeto. Por favor, aguarde atualizações.]

Uso

[Observação: Esta seção será atualizada no futuro com exemplos e instruções detalhadas sobre como usar o projeto. Por favor, aguarde atualizações.]

Tecnologias

As seguintes tecnologias estão sendo utilizadas no desenvolvimento deste projeto:

  • Linguagem de Programação: Rust
  • Framework: Actix Web
  • Banco de Dados: PostgreSQL
  • ORM (Object-Relational Mapping): Diesel

Essas são as tecnologias que estão sendo empregadas no projeto. Se necessário, esta seção pode ser expandida no futuro para incluir outras tecnologias ou detalhes adicionais.

Contribuição

Para contribuir com o projeto HelpDevas, siga as diretrizes abaixo:

  • Issues serão criadas e deixadas no projeto para indicar tarefas disponíveis para contribuição. Caso deseje contribuir, pegue para si uma issue e trabalhe nela.
  • Qualquer adição de código deve ser feita em sua própria branch. Certifique-se de nomear sua branch de forma significativa e descritiva.
  • Para adicionar qualquer código à branch de desenvolvimento, é necessário criar um Pull Request (PR). O PR só será aceito após revisão e aprovação por parte do responsável pelo projeto.

Agradecemos antecipadamente por suas contribuições!

Licença

Este é um projeto sem fins lucrativos e, portanto, não está associado a nenhum tipo específico de licença. Se você optar por utilizar este projeto de alguma forma, solicitamos apenas que nos mencione de alguma forma, reconhecendo o trabalho realizado. Sinta-se à vontade para usar este projeto da maneira que melhor lhe convier.

About

RestAPI do sistema HelpDevas - Backend do sistema que tem como objetivo fazer o registro de aspirantes do vale do amanhecer.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published