Projeto Integrador

iFood | Digital House | Potência Tech

<Elej@>

Sobre o projeto

O objetivo do presente projeto está voltado para o desenvolvimento de uma API que possibilitará o voto eletrônico para as eleições gerais, viabilizando o voto autenticado e direto através da internet. O sistema será acessado via web, através do dispositivo do eleitor que deverá efetuar cadastro prévio no mesmo com os dados devidamente validados nos sistemas do TRE e TSE. O voto eletrônico digital e remoto facilitará o acesso ao exercício do direito máximo à democracia, possibilitando alcance para quem tem dificuldade de locomoção, pessoas acamadas, pessoas que residem em zona rural com limitações físicas, de saúde ou ainda para o eleitor que não quer se abster do conforto de sua casa para exercer o seu direito constitucional.

Manual de Instalação

Clone o repositorio:

git clone https://github.com/luizns/eleja.git
cd eleja

Instale as dependências:

npm install

Set as variáveis de environment:

cp .env.example .env
# open .env and modify the environment variables

Índice

• Projeto Integrador
  • <Elej@>
    • Sobre o projeto
  • Manual de Instalação
  • Índice
  • Comandos
  • Variáveis de Environment
  • Estrutura do projeto
  • API Endpoints
  • Doc Swagger
  • Contribuidores:
• VOA GRUPO 7 !!!!!

Comandos

Rodando em desenvolvimento:

npm start

Variáveis de Environment

As variáveis de environment pode ser encontradas e modificadas no arquivo .env.

#PORTA DO SERVIDOR

API_PORT= # default 3000

##VARIAVEIS DE AMBIENTE MYSQL
DB_TYPE=mysql
DB_PORT=3306
DB_HOST=localhost
DB_USERNAME=root
DB_PASSWORD=
DB_DATABASE=

#HASH

# CRIPTOGRAFIA DE SENHA
PASSWORD_SALT=

#JWT
JWT_PRIVATE_KEY=

Estrutura do projeto

src\
 |--config\         # Environment variables and configuration
 |--\app\controllers\    # Controllers
 |--\app\models\         # Mongoose models
 |--\app\services\       # Business logic
 |--\app\utils\          # Utility classes and functions
 |--\database\index.js   # Database migration
 |--docs\         # Documentation
 |--middlewares\    # Custom express middlewares
 |--routes\         # Routes
 |--validations\    # Request data validation schemas
 |--uploads\    # Request image candidats 

API Endpoints

Lista de routes disponíveis:

Todas as rotas você pode importar para o insomnia ou postman para testá-la!

Também pode utilizar o documento Swagger:

Doc Swagger

http:localhost:3000/docs

Contribuidores:

Todos os contribuidores do projetos:

Rodrigo Moreira Lima

Daniel dos Santos Filho

Acácio Novoa Monteiro

Ubirajara Tamer Pinto Júnior

Luiz Nascimento da Silva

Jackson de Oliveira

VOA GRUPO 7 !!!!!