thennull / oficina

Modelo de backend utilizando uma api tipo REST para uma Oficina - projeto realizado para um cliente visando automatização e modernização de processos manuais.

Oficina

Uma API REST para criação de ordens de serviço, onde a base de dados está em mongoDB bem como o restante da API está em express. Neste ambiente é possível cadastrar clientes, funcinários e administradores. A authenticação dos usuários é realizada via token JWT (client side token authentication). OBS: Dentro do código eu utilizo referências em Inglês e alguns comentários em Inglês. Primeiro por que eu quero... kidding! Tenho este hábito em projetos onde eu sou o único responsável, escrevo e leio em Inglês sem problema algum, acho mais simples e direto e muitas vezes less typing!

Veja os docs »

Report Bug · Request Feature

Sobre o Projeto

A idéia do projeto surgiu a partir da necessidade de uma oficina da cidade de Itabira, em organizar suas ordens de serviço, clientes, serviços e produtos de uma maneira consolidada e com uma base de dados local através de um sistema que pudesse otimizar o processo, gerar histórico, relatórios, envio de emails e etc. Uma completa modernização do processo que anteriormente era manual. No projeto original a base de dados está em PostgreSQL além de outras pequenas diferenças que por motivos óbvios não estão aqui. Neste repositório está um sistema backend completo conforme descrito acima, porém simplificado em relação ao original utilizado no cliente, como por exemplo a base de dados, que esta em MongoDB aqui.

Primeiros Passos

Para ter uma cópia local deste repositório, faça conforme abaixo:

Prerequisitos

• npm

  npm install npm@latest -g

Instalação

1. Clone the repo

   git clone https://github.com/thennull/Oficina.git

2. Install NPM packages

   npm install

Como utilizar

Você vai precisar que seu ambiente tenha instalado: Node.JS >= 12, MongoDB = 3.6.8, npm = 7.19.1 e o git. Depois que realizar o clone do repositório conforme descrito em "Instalação", basta realizar o start do server:

npm start

Isso vai rodar a versão de produção do ambiente.

Descrição

Por se tratar de uma api REST você terá os seguintes pontos de entrada via HTTP:

/api/v1/servicos
/api/v1/produtos
/api/v1/users
/api/v1/carros
/api/v1/manutencoes

Você deve alterar a porta onde seu server vai ouvir por conexões e seu hostname no arquivo: config/config.env

PORT=3000
SERVER=http://localhost

Para importar os dados utilizados no projeto, utilize o script abaixo:

cd utils/
node mongoImport.js --create

Obs: Este script foi criado para ser uma forma simples de importar e deletar toda a base durante o desenvolvimento.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Marcio Lage - @thennull - [email protected]

Project Link: https://github.com/thennull/Oficina