Jessica-gouveia / SPporElas-project-reprograma

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

São Paulo por: ELAS 🚀💜

---

Sobre │ Contexto │ Regras │ Arquitetura │ Rotas │ Tecnologias │ Pacotes │ Pré-requisitos │ Contribuição │ Autora

---

Sobre

Projeto de conclusão do bootcamp de Back-end da {reprograma} em parceria com a Accenture. O projeto São Paulo por: ELAS, tem por objetivo mostrar a história de São Paulo através do olhar das mulheres que vivem ou viveram aqui.

Contexto

Uma mesma história pode ser contada de inúmeras maneiras, uma mesma cidade pode ser vivida e apreciada de infinitas formas. Todos os olhares importam, então , por que vemos sempre com os mesmos olhares?

Somos a maioria da população de São Paulo, cerca de 51% segundo SEADE , porém fazendo uma pesquisa rápida quando se digita mulher e São Paulo, os resultados são : feminicídio, abuso, desigualdade , dentre outros resultados lastimáveis. Somos representadas sempre por tristes estatísticas e foi pensando nisso que resolvi criar essa API.

Seja muito bem vinde a API São Paulo por : ELAS 🚀, essa API vai te apresentar a cidade de São Paulo sob o olhar de mulheres através do seu LEGADO. Sejam elas cis ou trans todas são celebradas com rotas culturais e gastronômicas que se conectam à história delas! Na rota cultural você conhecerá a história de uma mulher incrível os museus, parque e teatro indicados segundo cada perfil, também será possível fazer a rota gastronômica baseado nessa mesma mulher. Cerca de 80% dos restaurantes escolhidos são de chefs e até mesmo a equipe toda só de mulheres.

Regras

As demandas do negócio são:

• Somente pessoas com login e senha - podem criar ou excluir informações sobre os itinerários culturais;

• Conseguir visualizar ambas as rotas através de IDs;

  Arquitetura

   📁 Projeto-final
     |
     |-  📁 src
     |    |
     |    |- 📁 data
     |         |- 📄 database.js
     |
     |    |- 📁 controllers
     |         |- 📄 culinariaController.js
     |         |- 📄 culturalController.js
     |         |- 📄 usuariaController.js
     |
     |    |- 📁 models
     |         |- 📄 culinaria.js
     |         |- 📄 cultural.js
     |         |- 📄 usuaria.js
     |
     |    |- 📁 routes
     |         |- 📄 culinariaRouter.js 
     |         |- 📄 culturalRouter.js
     |         |- 📄 index.js   
     |         |- 📄 usuariaRouter.js 
     |
     |
     |- 📄 .env
     |- 📄 .env.example
     |- 📄 .gitignore
     |- 📄 package
     |- 📄 procfile
     |- 📄 server.js
  
  

  Rotas

  
  

  • Início

  Feature	Autenticação	Método	Rota
  Boas Vindas	❌	GET	/

  
  

  • Cultural

  Feature	Autenticação	Método	Rota
  Todos os itinerários culturais	❌	GET	/cultural/
  Escolher itinerário pelo ID	❌	GET	/cultural/{:id}
  Atualizar informação de nome	❌	PATCH	/cultural/{:id}
  Atualizar qualquer informação	❌	PATCH	/cultural/atualizar/{:id}
  Criar itinerário	✔️	POST	/cultural/cadastrar
  Deletar matéria	✔️	DELETE	/cultural/{:id}

  
  

  • Culinária

  Feature	Autenticação	Método	Rota
  Todos os restaurantes	❌	GET	/culinaria/
  Restaurantes por ID	❌	GET	/culinaria/{:id}
  Atualizar nome	❌	PATCH	/culinaria/{:id}
  Atualizar qualquer informaçao	❌	PATCH	/culinaria/atualizar/{:id}
  Criar matéria	❌	POST	/culinaria/cadastrar
  Deletar matéria	❌	DELETE	/culinaria/{:id}

  
  

  • Usuária

  Feature	Autenticação	Método	Rota
  Cria usuária	❌	POST	/usuaria/create
  Fazer login	❌	POST	/usuarias/login

  Tecnologias

  • VsCode

  • Node.js

  • Postman

  • MongoDB

  Pacotes

  

Contribuição

• Faça um fork do projeto;

• Copie a url do fork realizado e, no prompt de comando da sua máquina, realize o clone do projeto através do git clone <link_do_fork_do_repositorio>;

• Crie uma branch para realizar suas contribuições git checkout -b feature/<sua_branch>;

• Instale as dependências necessárias à execução da API através do comando npm install;

• No raiz do projeto, renomeie .env.example para .env e adicione os valores das variáveis PORT (porta sugerida 8080), MONGODB_URL (string de conexão com o banco de dados) e SECRET (chave RSA). Elas são necessárias para a execução da API em sua máquina;

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

• Após suas contribuições 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 contribuições para o projeto original.

Autora

Made with 💜 by Jéssica Gouveia