https://github.com/gabriel4420/backend_revelo
API para o controle do estoque e venda de uma loja de produtos diversos, relacionada ao desafio da empresa comunik.me, invitada pela plataforma revelo.
https://github.com/gabriel4420/backend_revelo
api-rest backend nodejs
Last synced: 2 months ago
JSON representation
API para o controle do estoque e venda de uma loja de produtos diversos, relacionada ao desafio da empresa comunik.me, invitada pela plataforma revelo.
- Host: GitHub
- URL: https://github.com/gabriel4420/backend_revelo
- Owner: Gabriel4420
- Created: 2021-10-26T02:45:32.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-01-16T21:41:21.000Z (over 1 year ago)
- Last Synced: 2025-04-14T07:13:48.000Z (about 1 year ago)
- Topics: api-rest, backend, nodejs
- Language: JavaScript
- Homepage:
- Size: 464 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📖 DOCUMENTAÇÃO 📖
API para o controle do estoque e venda de uma loja de produtos diversos, relacionada ao desafio da empresa comunik.me, invitada pela plataforma revelo.
Logo abaixo, segue as rotas da api que funcionam
#### ⚠️ IMPORTANTE ⚠️
É importante gerar um token e se autenticar para poder usar as rotas abaixo:
POST >> /login >> JSON-BODY
| Verb | Action | url |
| ------ | ------ |------ |
| GET | Get Users | '/users' |
| GET | Get Products | '/products' |
| POST | Add User | '/users' |
| POST | Add Product | '/product' |
| PATCH |Update Product | '/product/:id' |
## 👨💻️ Tecnogias utilizadas
O projeto foi desenvolvido utilizando a seguinte tecnologia:
- [NodeJS](https://node.com.br)
### Padronização de código
- [Prettier](https://prettier.io/)
### IDE
- [Visual Studio Code](https://code.visualstudio.com/)
## 📦️ Como utilizar o projeto
Para copiar o projeto, utilize os comandos:
```bash
# Clonar o repositório
❯ git clone https://github.com/Gabriel4420/backend_revelo.git
```
Para instalar as dependências e iniciar o projeto, você pode utilizar o yarn ou npm:
**Utilizando yarn**
```bash
# verificar as dependências
❯ yarn
# rodar projeto
❯ yarn dev
```
**Utilizando npm**
```bash
# Atualizar as dependências
❯ npm install
# Iniciar o projeto
❯ npm dev
```
Feito com ❤️ por Gabriel Rodrigues 👋️ Entre em contato!
