Products-API

API for product website, with all standard features

Projeto Products Api

Neste projeto, foi desenvolvida uma API para simular uma loja Typescript.

---

📃 Sobre o Projeto

Foram desenvolvidas todas as camadas da aplicação (Models, Service e Controllers), e por meio desta aplicação, será possível realizar as operações básicas que se pode fazer em um determinado banco de dados: CRUD.

🛠 Tecnologias e Bibliotecas utilizadas no desenvolvimento do projeto

• Node.js

• Express

• Nodemon

• TypeScript

  MONGODB

---

🚀 Como executar o projeto

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:

• Git
• Node.js
• Mysql para rodar local ou Docker para rodar em container.

É recomendado utilizar algum cliente HTTP, como Postman ou o Insomnia.

Também é bom ter um editor para trabalhar com o código como VSCode

---

1- Clonar o repositorio

git clone git@github.com:Sandrosss/Products-API.git

---

🐳 Rodando no Docker

Com Docker

Rode o serviço node com o comando

  docker-compose up -d

• Esse serviço irá inicializar dois containers chamados trybesmith e outro chamado trybesmith_db.
  • A partir daqui você pode rodar o container via CLI ou abri-lo no VS Code.

Via CLI use o comando

docker exec -it blogs_api bash

• Ele te dará acesso ao terminal interativo do container blogs_api(node) criado pelo compose, que está rodando em segundo plano.

Instale as dependências dentro do container com

npm install

⚠️Atenção: Caso opte por utilizar o Docker, TODOS os scripts disponíveis no package.json devem ser executados DENTRO do container, ou seja, no terminal que aparece após a execução do comando docker exec.

---

💻 Rodando Localmente

Instale as dependências com o comando

npm install

• Para rodar o projeto desta forma, obrigatoriamente você deve ter o node instalado em seu computador.
  • Recomenda-se a versão ^16

⚠️Atenção: Não esqueça de renomear/configurar o arquivo .env example

---

💡 Scripts prontos

Scripts

• Criar o banco de dados e gerar as tabelas:

  npm run dbcreate

• Iniciar o servidor Node:

  npm start

• Iniciar o servidor Node com nodemon:

  npm run dev

---