Git Product home page Git Product logo

js-pdv's Introduction

visitors GitHub Repo stars GitHub pull requests GitHub closed issues

API Sistema de PDV

Este projeto foi desenvolvido como parte do Módulo 5 da Cubos Academy. Consiste em uma API de um Sistema de Ponto de Vendas, onde é possível realizar operações como upload, exclusão e alteração de imagens utilizando a ferramenta Backblaze. Além disso, o sistema permite o envio de e-mails com pedidos realizados através do SendGrid e o deploy é realizado pela Cyclic.

Nota: Inicialmente, este projeto foi realizado em um grupo de 5 pessoas, no qual fui escolhida para ser a líder. No entanto, buscando aprimorar ainda mais meus conhecimentos, decidi refazer o projeto do zero.

👩‍🔧 Linguagens e Ferramentas

JavaScript Postgres Visual Studio Code Insomnia Beekeeper Git GitHub

Cyclic | SendGrid | BackBlaze

🖌️ Layout

  • Em breve

🚩 Contribua com o projeto

  • Realize o Fork
  • Faça as modificações necessárias
  • Realize a Pull Request (PR)

🗃️ Fucionalidades do Projeto

  • Gerenciamento de Usuários

    • Cadastrar Usuário
    • Fazer Login
    • Detalhar Perfil do Usuário Logado
    • Editar Perfil do Usuário Logado
  • Gerenciamento de Categorias

    • Listar categorias
  • Gerenciamento de Clientes

    • Listar clientes
    • Detalhar cliente
    • Cadastrar cliente
    • Editar cliente
    • Remover cliente
  • Gerenciamento de Pedidos

    • Cadastrar pedido
    • Detalhar pedido
  • Envio de E-mails

💻 Rodando o Projeto

# 1. Clone o projeto

git clone https://github.com/christianebs/js-pdv/

# 2. Instale as dependências

npm install

# 3. Execute o servidor com nodemon para reinicialização automática

npm run dev

Observações:

  • As dependências estão definidas no arquivo package.json. Ao executar npm install, todas elas serão instaladas
  • O arquivo package.json já contém a configuração necessária na seção de scripts para utilizar o nodemon:
"scripts": {
    "dev": "nodemon ./src/index.js"
},

Essa configuração permite iniciar o servidor em modo de desenvolvimento usando o nodemon.

  • Não é necessário inicializar um novo projeto Node.js com npm init -y, pois ao clonar o repositório, você já terá um package.json configurado.
  • Para encerrar todos os serviços, utilize o atalho padrão do terminal pressionando CTRL+C. Esse comando interrompe a execução dos processos, encerrando o servidor e liberando o terminal.

🔄 Endpoints

  • GET /categoria - Listar todas as categorias cadastradas
  • POST /usuario - Cadastrar um novo usuário no sistema
  • POST /login - Realizar o login de um usuário cadastrado
  • GET /usuario - Obter informações do perfil do usuário autenticado
  • PUT /usuario - Atualizar informações do perfil do usuário autenticado
  • POST /produto - Adicionar um novo produto associada ao usuário logado
  • GET /produto - Obter uma lista de todos os produtos do usuário logado
  • GET /produto/:id - Consultar detalhes de um produto específico do usuário logado
  • PUT /produto/:id - Atualizar informações de um produto do usuário logado
  • DELETE /produto/:id - Excluir um produto do usuário logado
  • POST /cliente - Adicionar um novo cliente associado ao usuário logado
  • PUT /cliente/:id - Atualizar informações de um cliente do usuário logado
  • GET /cliente - Obter uma lista de todos os clientes do usuário logado
  • GET /cliente/:id - Consultar detalhes de um cliente específico do usuário logado
  • POST /pedido - Adicionar um novo pedido associado ao cliente
  • GET /pedido - Obter uma lista de todos os pedidos do cliente

👩‍💻 Desenvolvedora


Christiane Barbosa

js-pdv's People

Contributors

christianebs avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.