lucasqueirogaa / black-challenge-4-inventory-api

API para controle de estoque utilizada no Desafio #4 do OneBitCode Black

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

imghorizontallogoobc

API CRUD para controle de estoque

📖 Descrição

Esse é um projeto de API CRUD que tem como objetivo fazer o controle de estoque.
A ideia é fazermos aqui a reestruturação dela, para usarmos conceitos do Clean Code e do SOLID.


📡 Tecnologias utilizadas

NodeJs Sequelize JavaScript Express Postgresql


⏳ Inicialização

  • Esse projeto foi desenvolvido em ambiente Linux, utilizando o Ubuntu 22 e as tecnologias citadas anteriormente. Caso você utilize outro sistema operacional, a configuração inicial do projeto pode ser um pouco diferente, por isso sugerimos que você acesse os links indicados abaixo:

  • A preparação do ambiente consiste em instalar as tecnologias citadas anteriormente de acordo com seu sistema operacional.

  • Para instalar o Node.js, acesse: https://nodejs.org/pt-br/download/package-manager/

  • O sequelize deve ser configurado conforme orientações da documentação oficial: https://sequelize.org/docs/v6/getting-started/

  • Para utilizar o express, ele também deve ser instalado: https://expressjs.com/pt-br/starter/installing.html

  • Depois de ter seguido todos os passos, pode instalar as dependências utilizando:

npm install
  • Agora, você deve configurar o seu banco de dados, ao entrar na pasta "config.json", você vai modificar de acordo com o que você está criando e usando, modifique de acordo com os seguinte campos:
postgres://usuario:senha@localhost:5432/nome-do-banco
  • A mesma coisa deve ser feita para o "index.js", modificando também a sua URL

📓 O que deve ser feito

  1. Testar todo o projeto no postman para verificar se tudo está funcionando (Antes de qualquer alteração). No final do readme temos um link para os testes no postman.

  2. Reestruturar o projeto de acordo com os conceitos vistos no Clean Code e no SOLID

  3. Deixar o projeto funcionando depois de ter modificado ele com todos os conceitos ditos acima, entregando antes do dia 30/09, para avaliação.


🤵🤵‍♀️ Colaboradores

Os colaboradores desse projeto são os Instrutores da OneBitCode: Lucas Queiroga (Que está guiando o desafio e fará a resolução do projeto), Juliana Conde (Que contribuiu com o desenvolvimento do projeto, na resolução, no enunciado e no arquivo readme) e Isaac Pontes (Que criou a API e auxiliou no desenvolvimento do enunciado, na resolução e no arquivo readme). Além de todos os alunos do OneBitCode Black ❤️


🔎 Status do Projeto

Badge em Desenvolvimento


📑 Referências

Link do arquivo para o postman: https://drive.google.com/drive/folders/1-Zj1iqAw2_xRX2NTHe0A_hk0Z40qa9Bk?usp=sharing

Visite o site da OneBitCode para conhecer os cursos e projetos https://onebitcode.com/lp/

Siga nossa página no instagram: @onebitcode

Se inscreva no nosso canal do YouTube: https://www.youtube.com/c/OneBitCode

Conheça o OneBitCode Black: https://chat.whatsapp.com/LOLzh57CDc81UOguDP0OUN

About

API para controle de estoque utilizada no Desafio #4 do OneBitCode Black


Languages

Language:JavaScript 100.0%