🚧 STATUS - EM DESENVOLVIMENTO 🚧
- Objetivo
- Tecnologias
- Dependências
- Aprendizados
- Instruções para a Utilização da API
- Informações sobre as rotas
- Próximos passos
- Autora
Com a finalidade de consolidar os conhecimentos aprendidos durante o bootcamp de back-end de 18 semanas da {reprograma}, fomos desafiadas a desenvolver uma API capaz de executar um CRUD em um banco de dados. Precisando também fazer o deploy desse projeto no Heroku e documentar o processo por meio desse repositório no Github.
A fim de apoiar a minha, e a de quem mais tiver interesse, transição do vegetarianismo ao veganismo, criei uma aplicação voltada à união de referências relativas ao estilo de vida vegano, tendo como foco inicial reunir em um só lugar diversos pequenos empreendimentos veganos.
Para o CRUD solicitado, criarei inicialmente as funções de criar, ler, atualizar e deletar empreendimentos veganos.
Visual Code Studio • Javascript e NodeJS • Github • MongoDB Atlas e Heroku • Postman • Dependencias
O ambiente de desenvolvimento de software utilizado foi o Visual Studio Code, indicado desde as primeiras aulas do curso da {reprograma}.
Ao longo da trajetória do bootcamp eu instalei 4 extensões ao programa:
- Live Server: extensão instalada durante o processo de seleção para o curso, em um workshop;
- Bracket Pair Colorizer: extensão que ajuda na visualização de chaves, colchetes e parênteses deixando da mesma cor o elemento de abertura e de fechamento e sinalizando quando há um faltante;
- Prettier: quando instalada, é possível organizar a identação do código ao invés do comando "Format document with > Prettier"; e
- Material Theme Icons: adiciona um ícone ao lado de cada arquivo, havendo ícones iguais pra arquivos de mesmo tipo e ícones diferentes para tipos diferentes.
A linguagem de desenvolvimento do projeto foi JavaScript, tendo sido o NodeJS o ambiente de execução da linguagem utilizado.
A plataforma github foi utilizada para organização e controle das versões do projeto, tendo sido a linguagem git o meio de contato com essa ferramenta.
A partir da integração do diretório remoto do Github ao Heroku foi entregue um servidor remoto, o qual foi conectado ao MongoDBAtlas a fim de possibilitar o armazenamento dos dados na nuvem.
Por fim, a fim de testar os métodos HTTP desenvolvidos no empreendimentosController foi utilizado o software Postman.
Abaixo está uma relação das bibliotecas utilizadas no desenvolvimento do projeto e as versões no momento da última atualização do "README.md".
O projeto final foi o momento de por em prática muitos dos conhecimentos com os quais tive contato ao longo das últimas 18 semanas.
Além de todas as tecnologias utilizadas no projeto, ao longo dele e de todo o curso consegui consolidar habilidades como transformar problemas complexos em pequenos problemas, fazer as coisas por partes e não me desesperar com erros, mas tentar entendê-los, pesquisar sobre eles e pedir ajuda se necessário.
São pre-requisitos para o funcionamento do projeto as seguintes ferramentas:
Além disso, alguns softwares podem ser utilizados para auxiliar o desenvolvimento e a realização de testes, aqui, indico os seguintes:
Para auxílio no desenvolvimento:
Para realização de testes dos métodos HTTP:
- Copiar o link
https://github.com/marinamare/reprogramaSemanas17e18_projetoFinal.git - Criar um repositório na sua máquina com o nome
reprogramaSemanas17e18_projetoFinal - Abrir o terminal na pasta criada e, efetivamente, clonar o repositório através do comando:
git clone https://github.com/marinamare/reprogramaSemanas17e18_projetoFinal.git
npm install
-
Comece por adicionar um arquivo na raiz da pasta reprogramaSemanas17e18_projetoFinal chamado ".env"
Dentro desse arquivo serão configuradas as informações presentes no arquivo ".env.eample", que são as seguintes:
MONGODB_URL=stringDeConexao PORT=porta -
No arquivo .env você pode cole o modelo presente no .env.example;
-
No .env, substitua o conteúdo da variável
MONGODB_URLque é "stringDeConexao" pela URL padrão de acesso ao banco de dados local pelo MongoDB (http://localhost:27017) OU pela url de conexão de um cluster do MongoDB Atlas (caso você queira utilizar o banco de dados na nuvem). -
No .env, substitua o conteúdo da variável "PORT" por um número de porta a ser utilizada pelo servidor local no momento que ele rodar.
✨ Caso você opte por rodar localmente, após configurar as variáveis de ambiente no arquivo .env você já pode:
-
Ir ao terminal, na pasta do projeto, e rodar o servidor através do comando
npm run dev -
Ir ao software de interação com a API (aqui estamos utilizando o Postman) e testar as rotas propostas no projeto.
Caso você opte por utilizar o postman, pode importar o arquivo "projetoFinalReprograma.postman_collection.json" que é a coleção feita no programa com todas as rotas.
A fim de trilhar uma carreira em tecnologia conciliando minha formação em andamento em design e esse impulso que me foi dado pela {reprograma} em relação à área de desenvolvimento, meus próximos passos em relação ao projeto serão buscar formas de desenvolver e integrar interfaces a cada uma das rotas criadas.
Escolhi fazer isso através do uso do Atomic Design, iniciando o processo por elementos como botões e caixas de diálogo, criando uma espécie de mini design system que dê uma cara ao projeto e possibilite a produção e testagem mais dinâmica dos fluxos dentro da aplicação.
Marina Maré 🌊
Feito com 💚 por Marina Maré com apoio da {reprograma} 👋🏽 Entre em contato!
