efss7 / multiplier-commerce

API desenvolvida para o teste técnico da Multiplier

Sobre | Tecnologias | Link da API | Documentação | Features | Rodando o back-end | Desenvolvedor

📕 Projeto Multiplier Commerce

Uma API REST para uma plataforma ecommerce. Nessa API, podemos cadastrar categorias e produtos.A API foi desenvolvida utilizado as tecnologias TYPESCRIPT, NODE.JS, EXPRESS.JS, MYSQL como banco de dados e JEST para testes unitários. Além disso, o projeto foi estruturado utilizando PROGRAMAÇÃO ORIENTADA A OBJETOS(POO) e princípios S.O.L.I.D.

🛠 Tecnologias

• TypeScript
• NodeJS
• MySql
• Jest

🔗 Link base da API

https://multiplier-commerce.herokuapp.com

📃 Documentação do Postman

• Postman

✔️ Features

📂 Categorias

• Visualizar todas as categorias cadastrada
• Visualizar uma categoria específica
• Criar uma nova categoria
• Editar uma categoria já criada
• Deletar Categoria

🏷 Produto

• Visualizar todas as categorias cadastrada
• Visualizar um produto específico
• Criar um novo produto
• Editar um produto já criado
• Deletar produto e o seu estoque

📦 Estoque

• Visualizar o estoque de um produto específico.
• Editar o estoque de um produto específico
• Deletar o estoque de um produto

🎲 Rodando o Back End (servidor)

Pré-Requisitos

• Para rodar o projeto você vai precisar do Node.JS
• Uma instancia de um banco de dados MySQL
• Um editor para trabalhar com o código como VSCode

Como instalar e Rodar

• Para baixar o projeto

1. git clone https://github.com/efss7/multiplier-commerce.git
2. cd multiplier-commerce

• Para instalar e rodar o projeto

3. npm install
4. npm dev
    ou
3. yarn install
4. yarn dev

• Para rodar os testes

5. npm test
5. yarn test

Renomeie o arquivo .env.example para .env e preencha as variáveis com seus dados do banco de dados MySQL. É muito importante para a execução do servidor.

👨‍💻 Desenvolvedor

Eric Silva

Voltar para o topo ⬆️