RDM – Registro de Manutenções

RDM é um utilitário de linha de comando (CLI) para registrar e acompanhar as manutenções do seu carro. Você pode adicionar, listar, remover e calcular o gasto total de todas as manutenções. Além disso, o RDM permite sincronizar (copiar) o arquivo de dados para um HD externo, garantindo que você tenha backups seguros e uma maior tranquilidade em relação às informações do seu veículo.

Por que usar o RDM?

• Simples e rápido: Registre rapidamente as manutenções sem precisar de softwares complexos.
• Portável: Dados armazenados em um arquivo JSON, facilitando a edição e o backup.
• Controle de custos: Monitora facilmente quanto foi gasto em manutenções, como troca de óleo, revisão, troca de peças etc.
• Backup externo: Sincronize o banco de dados para um HD externo e mantenha sua informação segura.
• Acessível: Utiliza Node.js e pode ser executado em Windows, macOS e Linux.

Recursos Principais

1. Adicionar manutenção: Cria um registro contendo descrição, data e custo.
2. Listar manutenções: Exibe todas as manutenções já cadastradas.
3. Remover manutenção: Remove um registro específico pelo índice.
4. Calcular gastos totais: Mostra a soma de todos os custos cadastrados até o momento.
5. Sincronizar com HD externo: Copia o arquivo de dados para um local personalizado, facilitando backups e compartilhamento.

Como Funciona?

O RDM armazena seus dados em um arquivo car-maintenance.json localizado na home do usuário (por exemplo, C:\Users\SeuUsuario\car-maintenance.json no Windows ou /Users/SeuUsuario/car-maintenance.json no macOS). Graças ao lowdb, todos os dados ficam salvos em um formato JSON legível e fácil de manipular.

Instalação

Pré-Requisitos

• Node.js (recomendado versão 18 ou superior)
• NPM ou PNPM (ou outro gerenciador de pacotes Node)

Passo a passo

1. Clonar ou baixar este repositório:

   git clone https://github.com/seu-usuario/rdm.git
   cd rdm

2. Instalar dependências:

   npm install

   ou

   pnpm install

3. (Opcional) Instalar globalmente:

   npm link

   Dessa forma, você poderá executar o comando rdm de qualquer lugar do seu sistema.

Como Usar

1. Adicionar uma manutenção

rdm add --descricao "Troca de óleo" --data "2024-12-28" --custo 150

ou usando as opções abreviadas:

rdm add -d "Revisão dos freios" -D "2025-01-10" -c 300

Descrição (-d) e Data (-D) são obrigatórios. O Custo (-c) padrão é zero se não for informado.

2. Listar manutenções

rdm list

• Caso não haja registros, o CLI informará que não há nenhuma manutenção cadastrada.
• Se houver registros, cada manutenção será exibida com seu índice, descrição, data e custo.

3. Remover manutenção

Para remover uma manutenção pelo índice (conforme exibido em list):

rdm remove --indice 1

ou abreviado:

rdm remove -i 1

O índice inicia em 1 (não em zero).

4. Calcular gasto total

Exibe a soma de todos os custos cadastrados:

rdm total

Se não houver manutenções, retornará a mensagem de “Nenhuma manutenção cadastrada.”

5. Sincronizar (copiar) o banco para HD externo

rdm sync --destino "E:\backup\car-maintenance.json"

ou

rdm sync -d "/Volumes/HDEXTERNO/backup/car-maintenance.json"

Verifique se você possui permissão de escrita no caminho de destino. O arquivo car-maintenance.json será copiado na íntegra, garantindo um backup rápido e fácil.

Exemplos de Uso

• Registrar a troca de pneus:

  rdm add -d "Troca de pneus dianteiros" -D "2025-03-15" -c 600

• Verificar o gasto total:

  rdm total
  # Exemplo de saída: "Gasto total: R$ 750"

• Fazer backup:

  rdm sync --destino "D:\Meus Backups\car-maintenance.json"

Contribuindo

Contribuições são bem-vindas! Sinta-se à vontade para:

1. Abrir issues para relatar problemas ou solicitar novos recursos.
2. Enviar pull requests com melhorias no código, documentação ou testes.

Licença

Este projeto está licenciado sob a MIT License. Isso significa que você pode usar, modificar e distribuir à vontade, desde que mantenha o arquivo de licença.

Aproveite para manter seu carro sempre em dia e economizar planejando suas manutenções com o RDM! Se tiver dúvidas ou sugestões, fique à vontade para abrir uma issue ou nos contatar. Boas manutenções!