empreendemanas :hands:

O ponto de encontro de projetos de empreendedoras e um patrocinador que busca ajudar!

Como projeto final do bootcamp da @reprograma (turma backend 2/2019), essa API tem como proposta ser uma base de dados de projetos de mulheres que querem empreender, mas precisam de um incentivo financeiro. Através de um cadastro, a empreendedora (denominada "empreendemana") cadastra seus projetos, que ficam disponíveis para que quando, um patrocinador se cadastar, consiga visualizar os projetos e selecionar o que irá aplicar seu incentivo financeiro.

Pré-requisitos

Para utilizar essa API, é necessário ter instalado na sua máquina as tecnologias Node.JS e MongoDB.

Instalação 👩‍💻

Fork esse repositório para seu github. Clone na sua máquina. Após entrar na pasta pelo PROMPT, digite o comando npm install.

Utilização

Para inicialiazar o server:

npm start

Rotas

A API está sendo escutada na porta 3000, dessa forma, para todas as rotas serem acessadas localmente, use http://localhost:3000/ antes do caminho da rota

• POST /empreendemanas/ - adicionar usuários

Exemplo:

{ "nome": "Grayce Delfe", "email": "[email protected]", "foto": "img.png", "projetos": [ { "titulo": "Doces e Mimos Doceria", "descricao": "Uma doceria diferente, com a intenção de vender mas também oferecer cursos a donas de casa de baixa renda da cidade de São Paulo.", "valor": 900, "categoria": "Comércio" } ], "senha": "senha123" }

• POST /empreendemanas/login - realizar login dos usuários

Exemplo:

{ "email": "[email protected]", "senha": "senha123" }

• GET /empreendemanas - visualizar todas as empreendemanas

• GET /empreendemanas/projetos - visualizar todos os projetos existentes

• PATCH /empreendemanas/:id - atualizar uma empreendemana através do ID

Exemplo:

{ "email": "[email protected]" }

• DELETE /empreendemanas/:id - remover uma empreendemana e o projeto através do ID

Contribuindo com o projeto para o Hacktoberfest 2020

1. Faça o fork do projeto (https://github.com/grayceferreira/empreendemanas/fork)
2. Faça o checkout na branch master (git checkout master)
3. Crie uma branch para realizar suas modificações (git checkout -b feature/nome-da-sua-branch)
4. Após realizar as modificações, use o comando (git add .)
5. Faça o commit (git commit -m 'Digite sua mensagem aqui')
6. Push (git push --set-upstream origin feature/nome-da-sua-branch)
7. Crie um novo Pull Request para a branch feature/hacktoberfest

OU

Contribuindo com o projeto

1. Faça o fork do projeto (https://github.com/grayceferreira/empreendemanas/fork)
2. Faça o checkout na branch master (git checkout master)
3. Crie uma branch para realizar suas modificações (git checkout -b feature/nome-da-sua-branch)
4. Após realizar as modificações, use o comando (git add .)
5. Faça o commit (git commit -m 'Digite sua mensagem aqui')
6. Push (git push --set-upstream origin feature/nome-da-sua-branch)
7. Crie um novo Pull Request para a branch feature/develop