Skip to content

Sistema de visualização de histórico e gerenciamento de Ordens de Serviço para assistências técnicas

License

Notifications You must be signed in to change notification settings

IvanPSG-BR/NerdOS-API

Repository files navigation

NerdOS API

Índice

Descrição do Projeto

NerdOS é uma API para sistema de visualização de histórico e gerenciamento de Ordens de Serviço (OS) para assistências técnicas de celulares. A plataforma busca resolver problemas comuns enfrentados por assistências técnicas, como:

  • Dificuldade em rastrear o status de cada conserto.
  • Falta de um histórico organizado de serviços por cliente e aparelho.
  • Processos manuais e propensos a erros para gerar identificadores de OS.
  • Dificuldade em gerar relatórios e estatísticas de faturamento e produtividade.

Essa API fornece endpoints que salvam os dados acerca do cliente, seu aparelho e sobre o conserto em si, além de permitir seu gerenciamento. Isso cria um histórico de todos os clientes, aparelhos e consertos, permitindo que o usuário possa visualizar e gerenciar todos os dados de forma fácil e rápida.

Principais Módulos:

  • Autenticação e Usuários: Gerenciamento de usuários e autenticação segura.
  • Clientes: Cadastro e gerenciamento de clientes.
  • Ordens de Serviço: Criação e acompanhamento de OSs com fluxo de status claro (Em Análise, Aguardando Aprovação, Em Reparo, Concluído, Entregue), incluindo dados do aparelho.

Status do Projeto

O projeto NerdOS API encontra-se atualmente em desenvolvimento ativo.

Fase Atual: Implementação de Módulos

Última Atualização: 29/11/2025

Progresso Recente

  • Infraestrutura completa: Banco de dados PostgreSQL configurado com Prisma 7.0.1
  • Aplicação Fastify: Configurada com validação Zod e documentação Swagger
  • CRUD de Clientes: Implementado com arquitetura em camadas (Routes → Controller → Service → Model)
  • Histórico de Cliente: Endpoint consolidado para visualização de dispositivos e OSs
  • Módulo de Aparelhos removido: Dados de dispositivos serão gerenciados via Ordens de Serviço
  • 🚧 Em desenvolvimento: Módulo de Ordens de Serviço

Para mais detalhes sobre o progresso, consulte docs/Progresso.md.

Funcionalidades

As principais funcionalidades planejadas para a plataforma incluem:

Funcionalidades de Usuário:

  • Cadastro, login e gerenciamento de perfil de usuário.
  • Autenticação segura com hash de senha.
  • Validação de dados de entrada com critérios de segurança.

Funcionalidades de Clientes:

  • ✅ CRUD completo de Clientes (Nome, Sobrenome, DDD, Telefone/WhatsApp, CPF) - Implementado
  • ✅ Consulta de histórico do cliente (aparelhos + OSs) - Implementado

Funcionalidades de Ordem de Serviço:

  • Criação de OS vinculada a Cliente (com dados do aparelho incluídos na OS).
  • Geração automática de ID de OS (formato Char(15)).
  • Gestão de status da OS com fluxo claro.
  • Atualização de diagnóstico técnico, serviço realizado, peças utilizadas e valor final.
  • Endpoints de Dashboard com estatísticas de OS e faturamento.

Tecnologias Utilizadas

O desenvolvimento da NerdOS API utiliza as seguintes tecnologias:

  • Linguagem: TypeScript
  • Build Tool: pnpm
  • Framework Backend: Fastify
  • Framework de Testes: Jest
  • SGBD Relacional: PostgreSQL (Hospedado no Neon)
  • ORM: Prisma
  • Autenticação: jsonwebtoken com bcryptjs para hash de senhas
  • Validação de Schemas: Zod (Integrado via fastify-type-provider-zod)
  • Documentação de API: @fastify/swagger e @fastify/swagger-ui (Geração automática via Schemas Zod)
  • Configuração de Ambiente: dotenv

Licença

Este projeto está licenciado sob a Licença GNU General Public License v3.0.

About

Sistema de visualização de histórico e gerenciamento de Ordens de Serviço para assistências técnicas

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published