pretitudes-project-reprograma

Projeto de conclusão do Bootcamp de Back-end da @reprograma

MIT License

Stars
21
Committers
2

Banco de dados de candidaturas negras que concorreram a eleio municipal 2020 na Regio Metropolitana do Recife (PE).

Status: Concludo ✔️

Sumrio

Apresentao

O "Pretitudes" o projeto de concluso do bootcamp de Back-end da {reprograma}, em parceria com o projeto MINAs do Porto Digital. Essa uma API que tem por objetivo reunir informaes sobre as candidaturas negras comprometidas com a pauta antirracista na Regio Metropolitana do Recife.

A ideia que ela possa ser aproveitada por um programa de formao poltica e qualificao, quem sabe at de investimento, potencializando o movimento negro no prximo pleito eleitoral em 2024.

Contextualizao

A ausncia de representao negra nos parlamentos um problema h muito denunciado pelos movimentos negros brasileiros. Se no Brasil mais de 56% das pessoas se declaram negras, os dados de composio racial nas casas legislativas espalhadas pelo pas demonstram o tamanho do abismo. Segundo dados do TSE, negros somam 24,4% dos deputados federais e 28,9% dos deputados estaduais eleitos em 2018 e, dos vereadores eleitos em 2016, somam 42,1% de pretos e pardos. (Fonte: Votos Antirarcistas, 2020)

Fonte dos dados

Essa aplicao desenvolvida em parceria com o #VotosAntirracistas, uma plataforma on-line que rene e apresenta candidaturas negras comprometidas politicamente com as pautas histricas dos movimentos negros do Brasil, explicitadas no Manifesto Enquanto Houver Racismo No Haver Democracia, na Carta de Princpios e Agenda da Coalizo Negra por Direitos, na Agenda Marielle Franco e na Carta da Convergncia Negra em defesa da vida, do emprego e da participao negra na poltica.

Tambm usado como complemento de dados o site do Tribunal Superior Eleitoral - TSE.

Funcionalidades

  • Login de pessoa administradora da API (cadastro, atualizao e remoo de administradores)
  • Cadastro de candidaturas negras
  • Lista de todas as candidaturas negras cadastradas
  • Lista de todos os movimentos sociais das candidaturas negras cadastradas
  • Lista de candidaturas negras por cidade da Regio Metropolitana do Recife
  • Lista de candidaturas negras eleitas em 2020
  • Atualizao de cadastro de candidaturas
  • Remoo de candidaturas que no faam parte de movimentos sociais

Tecnologias, bibliotecas e dependncias

Instrues para instalao e contribuies no projeto

  • Faa um fork do projeto atravs do link (https://github.com/priscilaestevao/pretitudes-project-reprograma/fork);

  • Copie o cdigo do fork realizado e, no prompt de comando da sua mquina, realize o clone do projeto atravs do git clone <link_do_fork_do_repositorio>;

  • Crie uma branch para realizar suas contribuies git checkout -b feature/<sua_branch>;

  • Instale as dependncias necessrias execuo da API atravs do comando npm install;

  • No raiz do projeto, renomeie .env.example para .env e adicione os valores das variveis PORT (porta sugerida 8080), MONGODB_URL (string de conexo com o banco de dados) e SECRET (chave RSA). Elas so necessrias para a execuo da API em sua mquina

  • Para executar a API, utilize o comando npm start no seu terminal;

  • Aps suas contribuies no projeto, realize o commit com o comando git commit -m 'sua mensagem';

  • Para subir o projeto no seu GitHub, basta executar o comando git push origin feature/<sua_branch>;

  • E finalize criando um novo Pull Request com as contribuies para o projeto original.

Features e rotas

Esta API est sendo escutada na porta 8080 e para que todas as rotas possam ser acessadas localmente necessrio usar http://localhost:8080/ antes dos endpoints de requisio.

Manipulando registros como pessoa usuria

Feature Mtodo Rota
Lista de todas as candidaturas negras de 2020 GET /candidaturas-negras
Lista de todos os movimentos populares GET /candidaturas-negras/lista-movimentos
Filtro de candidaturas negras por cidade GET /candidaturas-negras/cidade/<nome-da-cidade>
Lista de candidaturas negras eleitas em 2020 GET /candidaturas-negras/eleitas2020

Manipulando registros como pessoa administradora (requer token de autenticao)

Feature Mtodo Rota
Login de pessoa administradora POST /admin/login
Cadastro de candidaturas negras POST /candidaturas-negras
Atualizao de cadastro de candidaturas por id PUT /candidaturas-negras/:_id
Remoo de candidaturas que no so de movimentos sociais DELETE /candidaturas-negras/participacao?movimentoSocial=unidefined
Cadastro de pessoa administradora POST /admin/
Lista de todas as pessoas administradoras GET /admin
Atualizao de cadastro de pessoa administradora por id PUT /admin/:id
Remoo de pessoa administradora por email DELETE /admin?email=<email_da_pessoa_administradora_castrada>

Referncias

{reprograma} - Projeto Final

Como escrever um README.md sensacional no Github

Inspirao: Pokemons API (autoria: @AnnaNee)

Tribunal Superior Eleitoral

Votos Antirracistas

Criado com 🖤 por Priscila Estevo e o apoio das professoras, monitoras, orientao pedaggica e minhas queridas companheiras de turma. Sou s gratido!