🛒 Sistema PDV
🔍 Sobre o Projeto O Sistema PDV uma aplicação RESTful que permite gerenciar um ponto de venda, oferecendo funcionalidades de autenticação, gerenciamento de usuários, categorias, clientes, pedidos , produtos e envio de email ao criar o pedido.
🛠️ Tecnologias e Ferramentas Utilizadas
Para usar a API, é necessário autenticar-se. Você deve obter um token JWT válido através do endpoint de login antes de acessar outros recursos. O token JWT deve ser incluído no cabeçalho de autorização de todas as solicitações subsequentes.
O sistema oferece as seguintes funcionalidades:
- Usuários: Cadastro, atualização, detalhamento do usuário logado, exclusão.
- Categorias: Cadastro, atualização, detalhamento de todas as categorias, detalhamento de uma categoria, exclusão.
- Clientes: Cadastro, atualização, detalhamento de todos os clientes, detalhamento de um cliente, exclusão.
- Pedidos: Criar, obter todos os pedidos.
- Produtos: Cadastro, atualização, detalhamento de todos os produtos, detalhamento de um produto, exclusão.
A seguir, temos o link da documentação oficial da nossa aplicação no Swagger: https://sistemapdv-0tm2.onrender.com/
obs: Pode ocorrer atraso no carregamento, pois se o UptimeRobot falhar, e, posteriormente, o deploy não for acessado por um certo período, uma requisição subsequente solicitará ao Render que a aplicação saia do "Modo Sleep".
Agradecemos pelo seu interesse em contribuir para o SISTEMA PDV API. Sua ajuda é valiosa para melhorar e expandir nossa aplicação. Abaixo estão as diretrizes e os passos para contribuir com nosso projeto.
Antes de começar, você deverá forkar o repositório do projeto para seu perfil.
Após o Fork, você precisará clonar o repositório forkado para seu ambiente de desenvolvimento local:
git clone https://github.com/{seu-usuario}/sistemapdv_api.git
cd sistemapdv_api
Certifique-se de ter Node.js instalado no seu sistema. Em seguida, instale as dependências necessárias:
npm install
ou
yarn install
ou
pnpm install
Antes de iniciar qualquer trabalho, crie uma branch separada para a sua contribuição. Use um nome descritivo para a sua branch:
git checkout -b feature/nova-funcionalidade
Faça as alterações necessárias no código, adicione novos recursos ou correções de bugs.
Garanta que suas alterações não quebraram nenhum recurso existente. Execute os testes e certifique-se de que todos passam:
npm run test
ou
yarn test
ou
pnpm test
Mantenha a documentação atualizada. Se você adicionou novos recursos, verifique se eles estão devidamente documentados no Swagger.
Após concluir suas alterações e testá-las, faça um commit das alterações:
git add .
git commit -m feat(nomeDoArquivo): Nova funcionalidade
Em seguida, envie suas alterações para o repositório:
git push origin feature/nova-funcionalidade
Vá para o repositório no GitHub e crie um Pull Request para que sua contribuição seja revisada. Certifique-se de descrever suas alterações e fornecer informações contextuais.
Após criar um Pull Request, nossa equipe revisará suas alterações e fornecerá feedback. Uma vez aprovado, suas alterações serão mescladas no projeto principal.
- Mantenha o código limpo e legível.
- Siga as boas práticas de desenvolvimento.
- Respeite as convenções de nomenclatura existentes.
- Documente adequadamente as alterações, recursos ou correções.
Para iniciar a aplicação, você pode executar um dos seguintes comandos, dependendo do seu gerenciador de pacotes preferido:
npm run dev
ou
yarn dev
ou
pnpm dev
Agradecemos pela sua contribuição e esperamos trabalhar juntos para tornar o SistemaPDV ainda melhor. Se você tiver alguma dúvida ou precisar de ajuda, não hesite em entrar em contato conosco. Juntos, podemos criar uma aplicação mais robusta e eficiente.