HidekiGus/teste-tecnico-igma

Teste técnico igma

Este teste técnico consiste em implementar uma API de cadastro de clientes

Os clientes são cadastrados com:

• CPF
• Nome
• Data de nascimento

🧰 Tecnologias utilizadas

• JavaScript com Node.js e Express.js
• PostgreSQL como banco de dados
• Prisma como ORM

🚦 Rotas

📥 GET /client

Nesta rota, é possível obter os dados de um cliente informando o seu CPF enviando um objeto no seguinte formato:

{
  "cpf": "123.456.789-00"    // ou "12345678900"
}

E espera-se uma resposta no formato:

[
  {
    "id": 1,
    "name": "Nome Sobrenome",
    "cpf": "12345678900",
    "birthdate": "01/01/2000"
  }
]

📮 POST /client

Nesta rota, é possível adicionar um novo cliente enviando seus dados (CPF, nome e data de nascimento) no seguinte formato:

{
    "name": "Nome Sobrenome",
    "cpf": "123.456.789-00",    // ou "12345678900"
    "birthdate": "01/01/2000"
}

E espera-se uma resposta no formato:

'Cliente criado com sucesso!'

📥 GET /clients/:page

Nesta rota, é possível obter os dados de todos os clientes de acordo com o número da página sendo passado como parâmetro da rota. Por padrão, os clientes criados mais recentemente aparecem primeiro ( isso pode ser alterado ).

• Observação: no código é possível definir o número de resultados por página. Por padrão, esse número é de 4 resultados por página. Para alterar esse número, em clientService.js, dentro da função getClientsService altere a variável clientsToTake para o número de resultados desejado por página.

Exemplo:

Para a rota /clients/1 com o número padrão de resultados, espera-se uma resposta no seguinte formato:

[
  {
    "id": 4,
    "name": "Nome Sobrenome 4",
    "cpf": "12345678904",
    "birthdate": "01/01/2000"
  },
  {
    "id": 3,
    "name": "Nome Sobrenome 3",
    "cpf": "12345678903",
    "birthdate": "01/01/2000"
  },
  {
    "id": 2,
    "name": "Nome Sobrenome 2",
    "cpf": "12345678902",
    "birthdate": "01/01/2000"
  },
  {
    "id": 1,
    "name": "Nome Sobrenome 1",
    "cpf": "12345678901",
    "birthdate": "01/01/2000"
  }
]

Para utilizar a API localmente, basta ter o Docker instalado e seguir esses passos:

1. Clone o repositório em uma pasta localmente abrindo o terminal e digitando:

git clone https://github.com/HidekiGus/teste-tecnico-igma.git

2. Na pasta que contém o repositório crie um arquivo .env para as variáveis de ambiente necessárias. No arquivo .env.example você encontra o modelo para a criação do .env, mas aqui vai um exemplo:

PORT=   // quando vazia, a aplicação automaticamente define a porta para 4000
DATABASE_URL=
POSTGRES_USER=
POSTGRES_PASSWORD=
POSTGRES_DB=

3. Com o .env criado e as variáveis adicionadas, agora abra o terminal na mesma pasta e digite:

docker compose up --build

4. Após a construção da imagem e do container estar rodando, você deve poder acessar a API localmente pela URL http://localhost:4000 ou http://localhost:PORT com PORT sendo a variável de ambiente definida no arquivo .env .

🎉 Pronto!

Testando a API

Para testar as rotas da aplicação e ver se está tudo funcionando corretamente, utilize o arquivo thunder-collection_Testes API.json no Thunder Client. Para utilizar o arquivo, entre na interface do Thunder Client, como na foto abaixo, e clique em Collections.

Agora, no canto inferior direito da foto mostra um ícone. Clique nele.

Selecione Import.

Agora escolha o arquivo thunder-collection_Testes API.json.

Se tudo der certo, uma nova aba aparecerá escrito Testes API

Passando o mouse sobre essa aba, aparecem 3 pontinhos na direita. Clique neles.

Agora clique em Run all.

Na nova tela que apareceu, clique em Run no canto superior direito.

Caso tudo ocorra como esperado, você deve ver uma tela igual a esta:

🎉 Prontinho, agora a API está configurada e testada, funcionando corretamente!

Curiosidade: Aqui tem o tempo que eu levei pra codar essa API.