Skip to content

Commit

Permalink
final update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Priscila Estevao da Cunha committed Dec 11, 2020
1 parent 59bfc4c commit e025460
Showing 1 changed file with 72 additions and 18 deletions.
90 changes: 72 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
[![Deploy on heroku](https://img.shields.io/badge/deploy-heroku.com-blueviolet)](https://pretitudes-project-reprograma.herokuapp.com/)
![badge node version](https://img.shields.io/badge/node-v12.18.3-brightgreen)
![badge npm version](https://img.shields.io/badge/npm-6.14.6-brightgreen)
![badge issues](https://img.shields.io/github/issues/priscilaestevao/pretitudes-project-reprograma)
![badge fork](https://img.shields.io/github/forks/priscilaestevao/pretitudes-project-reprograma)
![badge stars](https://img.shields.io/github/stars/priscilaestevao/pretitudes-project-reprograma)
![badge licence](https://img.shields.io/github/license/priscilaestevao/pretitudes-project-reprograma)

<h1 align="center">
<img src="public/images/pretitudes.png" alt="três pessoas negras segurando uma faixa com o nome Pretitudes" width="500">
<p align="center">Pretitudes - Ocupação preta na política<p>
Expand All @@ -6,33 +14,61 @@
> Banco de dados de candidaturas negras que concorreram a eleição municipal 2020 na Região Metropolitana do Recife (PE).
> Status: **Em Desenvolvimento** :warning:
</br>
</br>
## **Sumário**

1. [Apresentação](#Apresentação)
2. [Contextualização](#Contextualização)
3. [Fonte de Dados](#Fonte-de-dados)
4. [Funcionalidades](#Funcionalidades)
5. [Tecnologias, dependências e bibliotecas](#Tecnologias,-dependencias-e-bibliotecas)
6. [Instruções de instalação e contribuições no projeto](#Instrucoes-de-instalação-e-contribuições-no-projeto)
7. [Rotas HTTP](#Rotas-HTTP)
8. [Referências](#Referências)

</br>
</br>

## **Apresentação**

O "Pretitudes" é o projeto de conclusão do bootcamp de Back-end da [{reprograma}](https://reprograma.com.br/), em parceria com o [projeto MINAs do Porto Digital](https://www.portodigital.org/capital-humano/iniciativas-para-a-diversidade/mulheres-em-inovacao-negocios-e-artes-minas). Essa é uma API que tem por objetivo reunir informações sobre as candidaturas negras comprometidas com a pauta antirracista na Região Metropolitana do Recife.

A ideia é que ela possa ser aproveitada por um programa de formação política e qualificação, quem sabe até de investimento, potencializando o movimento negro no próximo pleito eleitoral em 2024.

</br>
</br>

## **Contextualização**

<img src="public/images/voto-em-negra.jpeg" alt="mulher com um adesivo colado na mão escrito voto em negra" width ="250" align="right" padding="150"/>

A ausência de representação 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 composição racial nas casas legislativas espalhadas pelo país 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)

</br>
</br>

## **Fonte dos dados**

Essa aplicação é desenvolvida em parceria com o [#VotosAntirracistas](https://votosantirracistas2020.com.br/), uma plataforma on-line que reúne e apresenta candidaturas negras comprometidas politicamente com as pautas históricas dos movimentos negros do Brasil, explicitadas no [Manifesto Enquanto Houver Racismo Não Haverá Democracia](https://comracismonaohademocracia.org.br/), na [Carta de Princípios e Agenda da Coalizão Negra por Direitos](https://coalizaonegrapordireitos.org.br/sobre/), na [Agenda Marielle Franco](https://www.agendamarielle.com/) e na [Carta da Convergência Negra em defesa da vida, do emprego e da participação negra na política](https://www.abpn.org.br/post/carta-resultante-da-plen%C3%A1ria-nacional-da-converg%C3%AAncia-negra).

Também é usado como complemento de dados o site do [Tribunal Superior Eleitoral - TSE](https://divulgacandcontas.tse.jus.br/divulga/#/).

</br>
</br>

## **Funcionalidades**
- [X] Cadastro de candidaturas negras
- [X] Cadastro de candidaturas negras (requer autenticação)
- [X] Lista de todas as candidaturas negras cadastradas
- [X] Lista de todos os movimentos sociais das candidaturas negras cadastradas
- [X] Lista de candidaturas negras por cidade da Região Metropolitana do Recife
- [X] Lista de candidaturas negras eleitas em 2020
- [X] Atualização de cadastro de candidaturas
- [X] Remoção de candidaturas que não façam parte de movimentos sociais
- [X] Atualização de cadastro de candidaturas (requer autenticação)
- [X] Remoção de candidaturas que não façam parte de movimentos sociais (requer autenticação)
- [X] Login de administrador da API (cadastro, atualização e remoção de administradores)
</br>
</br>

## **Tecnologias, dependências e bibliotecas**

Expand All @@ -47,6 +83,8 @@ Também é usado como complemento de dados o site do [Tribunal Superior Eleitora
:heavy_check_mark: Mongoose

:heavy_check_mark: Nodemon
</br>
</br>

## **Instruções de instalação e contribuições no projeto**

Expand All @@ -63,24 +101,40 @@ Também é usado como complemento de dados o site do [Tribunal Superior Eleitora
- 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 contribuições para o projeto original.
</br>
</br>

## **Rotas HTTP**
## **Features e rotas**

A API está sendo escutada na `porta 8080` e para que todas as rotas possam ser acessadas é necessário usar `http://localhost:8080/` antes dos endpoints de requisição.

- CREAT (método post) `/candidaturas-negras` - adicionar candidaturas negras;

- READ (método get) `/candidaturas-negras` - lista de todas as candidaturas negras de 2020;

- READ (método get) `/candidaturas-negras/lista-movimentos` - lista de todos os movimentos populares;

- READ (método get) `/candidaturas-negras/cidade/<nome-da-cidade>` - candidaturas negras por cidade;

- READ (método get) `/candidaturas-negras/eleitas2020` - candidaturas negras eleitas em 2020 por cargo representativo;

- UPDATE (método put) `/candidaturas-negras/:_id` - atualização de cadastro de candidaturas por id

- DELETE (método delete) `/candidaturas-negras/participacao?movimentoSocial=unidefined` - remoção de candidaturas que não são de movimento social
</br>
</br>

### _Manilando os registros como usuário comum_

| Feature | Método | Rota |
|---------|--------|------|
| Cadastro candidaturas negras | POST | `/candidaturas-negras` |
| 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` |
| Atualização de cadastro de candidaturas por id (autenticada) | PUT | `/candidaturas-negras/:_id` |
| Remoção de candidaturas que não são de movimentos sociais (autenticada) | DELETE | `/candidaturas-negras/participacao?movimentoSocial=unidefined` |
</br>

### _Manilando os registros como pessoa administradora_

| Feature | Método | Rota |
|---------------------------------------------------------|--------|----------------------------------------------------------|
| Login de pessoa administradora | POST | `/admin/login` |
| Cadastro de pessoa administradora | POST | `/admin/` |
| Lista de todas as pessoas administradoras | GET | `/admin` |
| Atualização de cadastro de pessoa administradora por id | PUT | `/admin/:id` |
| Remoção de pessoa administradora por email | DELETE | `/admin?email=<email_da_pessoa_administradora_castrada>` |

</br>
</br>

## **Referências**

Expand Down

0 comments on commit e025460

Please sign in to comment.