🚧 API CRUD 🚧

Sobre • Funcionalidades • Como executar • Tecnologias • Licença

💻 Sobre o projeto

Este projeto consiste é uma API rest simples onde terá algumas operações como: consultar, detalhar, alterar e remover.

---

⚙️ Funcionalidades

• Cadastrar cidade
• Consultar cidade pelo nome
• Consultar cidade pelo estado
• Cadastrar cliente
• Consultar cliente pelo nome
• Consultar cliente pelo Id
• Remover cliente
• Alterar o nome do cliente

---

🚀 Como executar o projeto

Este projeto contem 1 API REST

🎲 Rodando o Backend (servidor)

Execute o comando a baixo no MySQL para criar a base de dados

create database interview;

# Vá para a pasta principal
$ cd interview

# Instale as dependências
$ yarn

# Execute a aplicação em modo de desenvolvimento
$ yarn start:dev

# O servidor inciará na porta:3000 - acesse http://localhost:3000 

# Para acessar a documentação da API - acess http://localhost:3000/api/docs/#/

# Executando testes

$ yarn start:test

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

Server (NodeJS + TypeScript)

• Nest
• MySQL
• Jest

Veja o arquivo package.json

🦸 Autor

_{Lionan Dantas}

---

📝 Licença

Este projeto esta sobe a licença MIT.

Feito por Lionan Dantas 👋🏽 Entre em contato!