Contact APP

Sua Solução para organizar contatos!

🔗 Endpoints da aplicação

Segue os endpoints disponiveis da aplicação:

POST /login: Gera o token de autenticação.
GET /client: Lista todos os clientes.
POST /client: Criação de um novo cliente.
GET /client/profile: Lista o cliente logado - Necessita de autenticação.
DELETE /client/:id: Deleta o cliente - Necessita de autenticação.
POST /contact: Criação de um novo contato - Necessita de autenticação.
GET /contact: Lista todos os contatos do cliente logado - Necessita de autenticação.
PATCH /contact/:idContact: Atualiza um contato - Necessita de autenticação.
DELETE /contact/:idContact: deleta um contato - Necessita de autenticação.

🔧 Execução do Projeto

1. Para executar este projeto, é necessário executar o comando para instalar as dependências, que serão utilizadas. Portanto utilize o comando abaixo para instalar as dependências:

# Utilizando o yarn
yarn

# Utilizando o npm
npm install

2. Configuração de variáveis de ambiente:

• Renomeie o arquivo .env.example para .env.
• Corrija as variáveis de ambiente no arquivo .env com as informações da sua máquina.

3. Execute as migrações do banco de dados:

# Utilizando o yarn
yarn typeorm migration:run -d dist/data-source

# Utilizando o npm
npm run typeorm migration:run -d dist/data-source

4. Inicie o servidor:

# Utilizando o yarn
yarn dev

# Utilizando o npm
npm run dev

1. Após fazer todos os passos descritos a aplicação estará sendo executado em http://localhost:3000.