customers-register-api

Customers Register

Built With

Description

Um projeto typescript designado para cadastro de clientes através do CPF.

Features

Adiciona clientes no banco de dados.
Busca e lista todos os clientes usando paginação.
Busca cliente através do CPF.

API Reference

Utilize o arquivo customer_register_postman_collection.json para importar a coleção plataforma de API REST

Cria cliente

POST /customer/cpf

Request:

Body	Type	Description
`name`	`string`	Required. Seu lindo nome
`dateBirth`	`string`	Required. Sua data de nascimento
`cpf`	`string`	Required. Seu cpf

Response:

{
  "name": "NOME INSERIDO",
  "dateBirth": "DD/MM/AAAA",
  "cpf": "CPF INSERIDO"
}

Busca clientes

GET /customers?search=&take=&skip=

Request:

obs: essa requisição utiliza apenas Query Params.

Query Params	Type	Description
`search`	`integer`	Busca CPF especificado
`take`	`integer`	Lista quantos itens por página você deseja ver (se não for especificado valor, o padrão é 10)
`skip`	`integer`	Pula a quantidade de registros inserida(se não for especificado valor, o padrão é 0)

Environment Variables

Para executar este projeto, você precisará adicionar as seguintes variáveis de ambiente em seu arquivo .env

DATABASE_URL=postgres://${DATABASE_USER}:${DATABASE_PASSWORD}@${DATABASE_HOSTNAME}:5432/${DATABASE_DB}

PORT = number #recommended:5000

DATABASE_USER = string

DATABASE_PASSWORD = string

DATABASE_HOSTNAME = string #recommended: se for utilizar docker para rodar o projeto, utilize "db" como nome por conta que o db é o nome do service no docker-compose

DATABASE_DB = string

Run Locally

Clone o repositório

  git clone https://github.com/Tutuezin/customers-register-api.git

Instale as dependências

  yarn install ou npm install

Crie o banco de dados

  yarn dev:migration ou npm run dev:migration

Inicie o servidor

  yarn dev ou npm run dev

Run Tests

Rode os testes

  yarn test ou npm run test

Para popular novamente o banco de dados utilize

  yarn dev:seed ou npm run dev:seed

Run with Docker

Instale as dependencias e inicie o servidor

  docker compose up ou docker-compose up

Rode os testes

  docker container exec -it customers_node yarn test
                        ou
  docker container exec -it customers_node npm run test

Para popular novamente o banco de dados utilize

  docker container exec -it customers_node yarn dev:seed
                        ou
  docker container exec -it customers_node npm run dev:seed

tutuezin / customers-register-api Goto Github PK