https://github.com/tonyycruz/trybesmith
Neste projeto, foi desenvolvida uma API para simular uma loja de itens medievais utilizando Typescript.
https://github.com/tonyycruz/trybesmith
commit-conventions express jwt mysql mysql2 nodejs nodemon typescript
Last synced: 2 months ago
JSON representation
Neste projeto, foi desenvolvida uma API para simular uma loja de itens medievais utilizando Typescript.
- Host: GitHub
- URL: https://github.com/tonyycruz/trybesmith
- Owner: TonyyCruz
- Created: 2022-09-18T22:51:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-17T21:55:22.000Z (over 2 years ago)
- Last Synced: 2025-01-27T12:14:12.406Z (4 months ago)
- Topics: commit-conventions, express, jwt, mysql, mysql2, nodejs, nodemon, typescript
- Language: TypeScript
- Homepage:
- Size: 208 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Projeto Trybesmith Api
Neste projeto, foi desenvolvida uma API para simular uma loja de itens medievais utilizando Typescript.
---
📃 Sobre o Projeto
Foram desenvolvidas todas as camadas da aplicação (Models, Service e Controllers), e por meio dessa aplicação, será possível realizar as operações básicas que se pode fazer em um determinado banco de dados: Criação, Leitura, Atualização e Exclusão (ou CRUD, para as pessoas mais íntimas - Create, Read, Update e Delete). O REST foi feito utilizando MySql.
Rotas utilizáveis
Ver rotas
- POST `/products` para cadastrar novo produto. Utilize um body nesse formato:
```jsx
{
"name": "Adaga misteriosa",
"amount": "26 peças de ouro"
}
```
---
- POST `/users` para criar um novo usuário. Utilize um body nesse formato:
```jsx
{
"username": "Arthur",
"classe": "swordsman",
"level": 10,
"password": "kingArthur"
}
```
---
- POST `/login` para fazer login e receber um token. Utilize um body nesse formato:
```jsx
{
"username": "yourUser",
"password": "yourPassword"
}
```
---
- POST `/orders` para adicionar um novo pedido, o usuário precisa estar logado. Utilize um body nesse formato:
```jsx
{
"productsIds": [1, 2]
}
```
---
- GET `/products` para listar todos os produtos.
---
- GET `/orders` para listar todos os pedidos.
---
### 🛠 Tecnologias e Bibliotecas utilizadas no desenvolvimento do projeto
- **[Node.js](https://nodejs.org/en/)**
- **[MySQL](https://www.mysql.com/products/workbench/)**
- **[Mysql2](https://www.npmjs.com/package/mysql2)**
- **[Express](http://expressjs.com/pt-br/)**
- **[Nodemon](https://www.npmjs.com/package/nodemon)**
- **[JWT](https://jwt.io/introduction)**
- **[TypeScript](https://www.typescriptlang.org/pt/)**
---
### 🚀 Como executar o projeto
_Pré-requisitos_
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:
- [Git](https://git-scm.com)
- [Node.js](https://nodejs.org/en/)
- [Mysql](https://www.mysql.com/) para rodar local ou [Docker](https://docs.docker.com/get-docker/) para rodar em container.
É recomendado utilizar algum cliente HTTP, como [Postman](https://www.postman.com/) ou o [Insomnia](https://insomnia.rest/download).
Também é bom ter um editor para trabalhar com o código como [VSCode](https://code.visualstudio.com/)
---
_1- Clonar o repositorio_
```jsx
git clone [email protected]:TonyyCruz/trybesmith.git
```
---
:whale: Rodando no Docker
## Com Docker
_Rode o serviço `node` com o comando_
```jsx
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_
```jsx
docker exec -it trybesmith bash
```
- Ele te dará acesso ao terminal interativo do container trybesmith criado pelo compose, que está rodando em segundo plano.
_Instale as dependências `dentro do container` com_
```jsx
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.
---
:computer: Rodando Localmente
_Instale as dependências com o comando_
```jsx
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:
```sh
npm run dbcreate
```
- Iniciar o servidor Node:
```sh
npm start
```
- Iniciar o servidor Node com nodemon:
```sh
npm run dev
```
---
🎲 Diagrama Entidade Relacionamento do projeto
O banco de dados do projeto segue a estrutura abaixo:
