API para gerenciamento de clientes.
Para instalar as dependências do projeto, execute o comando abaixo:
$ npm install
ou
$ yarn
Crie um arquivo .env
na raiz do projeto e adicione as seguintes variáveis de ambiente (veja o aquivo .env.example
para um exemplo):
PORT=3000 ou a porta que desejar(recomendado 3000)
DB_HOST=host do banco de dados
DB_USER=usuário do banco de dados
DB_PASSWORD=senha do banco de dados
DB_NAME=nome do banco de dados
DB_PORT=porta do banco de dados
Para iniciar o servidor, execute o comando abaixo:
$ npm run dev
ou
$ yarn dev
A API estará disponível em http://localhost:3000
ou na porta que você definiu no arquivo .env
.
Antes de iniciar o servidor, é necessário criar a tabela no banco de dados. Para isso, execute o que se encontra no arquivo ddl.txt
na raiz do projeto.
Retorna a lista de clientes.
Cria um novo cliente.
Retorna a lista da rota em que a visitação deve ser feita.