Skip to content

skGab/Client-management-service

Repository files navigation

Client Management Service

Logo do Projeto

Status GitHub Issues GitHub Pull Requests License


💡 Desenvolvimento de um sistema de gestão de clientes, envolvendo a criação de uma API dedicada ao cadastro de clientes e contratos.

Índice

Tecnologias

  • Node.js
  • Typescript
  • NestJS
  • Zod (Validação)
  • Prisma

Objetivo

O objetivo deste serviço é complementar uma plataforma que abrange diversas funcionalidades essenciais, incluindo o acompanhamento dos prazos de vencimento dos contratos e a gestão do status do cliente, possibilitando diferenciar entre ativos e inativos, sendo possivel tambem o cadastro de clientes e contratos.

Funcionalidades

  • Cadastro de clientes
  • Gestão de vencimento de contratos
  • Controle de status de clientes
  • Cadastro de novos contratos

Requerimentos de qualidade

  • Escalavel
  • Performance
  • Sustentável

Instruções de Uso

Rotas para gerenciamento de clientes:

  • GET /clients
  • GET /clients/findOne/:id
  • POST /clients/registration

Rotas para gerenciamento de contratos:

  • GET /contracts/expiring
  • GET /contracts/all/:id
  • GET /contracts/findOne/:id
  • POST /contracts/registration

  • Certifique-se de ter o Node.js instalado em seu sistema. Em seguida, execute o seguinte comando para instalar as dependências do projeto:

npm install


  • Para iniciar o servidor de desenvolvimento local, utilize o seguinte comando:

npm run start:dev

O sistema estará disponível em http://localhost:8080/. As alterações no código serão recarregadas automaticamente no navegador durante o desenvolvimento.


  • Para criar a versão final do projeto otimizada para produção, execute o seguinte comando:

npm run build

Os arquivos finais serão gerados na pasta 'dist'.


  • Após o processo de build, visualize a versão de produção localmente com o seguinte comando:

npm run start:prod

O sistema estará disponível em http://localhost:8080/ em uma versão otimizada para produção.


  • O projeto utiliza ESLint para análise estática do código e Prettier para formatação. Verifique problemas de linting ou formate o código automaticamente com os seguintes comandos:

npm run lint

npm run format

Autor

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published