Sistema de Ponto de Venda

📌Sobre o projeto

Projeto piloto de desenvolvimento de uma API para um PDV (Frente de Caixa), realizado como projeto final do curso de Desenvolvimento de Software com Foco em Back-end da Cubos Academy.

Acesso ao sistema:

Você pode acessar e usar nossa aplicação diretamente através do link de deploy:

PDV - Acesse Aqui

📌Funcionalidades

Listar categorias
Cadastrar Usuário
Efetuar Login do Usuário
Detalhar Perfil do Usuário Logado
Editar Perfil do Usuário Logado
Cadastrar Produto
Editar Dados do Produto
Listar Produtos
Detalhar Produto
Excluir Produto por ID
Cadastrar Cliente
Editar dados do Cliente
Listar Clientes
Detalhar Cliente
Cadastrar Pedido
Listar Pedidos

📌Utilização

Para uma utilização eficiente da nossa aplicação, listaremos abaixo todos os endpoints com suas funcionalidades e devidas rotas.

Para os testes utilizamos como url_base o nosso deploy:

1. Listar categorias

Endpoint: GET /categoria

Este endpoint permite que os usuários listem as categorias cadastradas.

✅Endpoints de Usuários

1. Cadastrar Usuário

Endpoint: POST /usuario

Este endpoint permite que os usuários registrem um novo usuário no sistema.

Corpo da requisição:

{
  "nome": "Nome do Usuário",
  "email": "[email protected]",
  "senha": "senha123"
}

Observação: todos os campos são obrigatórios.

2. Efetuar Login do Usuário

Endpoint: POST /login

Permite que um usuário cadastrado realize o login no sistema.

Corpo da requisição:

{
  "email": "[email protected]",
  "senha": "senha123"
}

Observação: Após realizar o login com sucesso, um token será retornado. Esse token deve ser utilizado para autenticação nos próximos endpoints, pois eles são protegidos.

3. Detalhar Perfil do Usuário Logado

Endpoint: GET /usuario

Este endpoint permite que um usuário visualize o seu perfil de forma detalhada.

Header:

Authorization: Bearer SEU_TOKEN

4. Editar Perfil do Usuário Logado

Endpoint: PUT /usuario

Este endpoint permite que um usuário logado atualize as informações do seu perfil.

Header:

Authorization: Bearer SEU_TOKEN

Corpo da requisição:

{
  "nome": "Novo Nome",
  "email": "[email protected]",
  "senha": "novaSenha"
}

Observação: Todos os campos são obrigatórios.

✅Endpoints de Produtos

1. Cadastrar Produto

Endpoint: POST /produto

Essa é a rota que permite o usuário logado cadastrar um novo produto no sistema.

Header:

Authorization: Bearer SEU_TOKEN

Corpo da requisição:

Observação: todos os campos são obrigatórios, exceto a imagem do produto.

2. Editar Dados do Produto

Endpoint: PUT /produto/:id

Essa é a rota que permite o usuário logado a atualizar as informações de um produto cadastrado.

Header:

Authorization: Bearer SEU_TOKEN

Corpo da requisição:

Observação: todos os campos são obrigatórios, exceto a imagem do produto.

3. Listar Produtos

Endpoint: GET /produto

Essa é a rota que será chamada quando o usuário logado quiser listar todos os produtos cadastrados.

Header:

Authorization: Bearer SEU_TOKEN

Requisição:

Caso seja enviado o parâmetro do tipo query categoria_id, filtrar os produtos de acordo com a categoria, caso o id de categoria informada exista.

Caso não seja informado o parâmetro do tipo query categoria_id todos os produtos cadastrados deverão ser retornados.

4. Detalhar Produto

Endpoint: GET /produto/:id

Essa é a rota que permite o usuário logado obter um de seus produtos cadastrados.

Header:

Authorization: Bearer SEU_TOKEN

5. Excluir Produto por ID

Endpoint: DELETE /produto/:id

Essa é a rota que será chamada quando o usuário logado quiser excluir um de seus produtos cadastrados.

Header:

Authorization: Bearer SEU_TOKEN

✅Endpoints de Clientes

1. Cadastrar Cliente

Endpoint: POST /cliente

Essa é a rota que permite usuário logado cadastrar um novo cliente no sistema.

Header:

Authorization: Bearer SEU_TOKEN

Corpo da requisição:

{
  "nome": "Nome do Cliente",
  "email": "[email protected]",
  "cpf": "99999999999",
  "cep": "99999999",
  "rua": "Rua teste",
  "numero": "99",
  "bairro": "Teste",
  "cidade": "Teste",
  "estado": "Te"
}

OU

{
  "nome": "Nome do Cliente",
  "email": "[email protected]",
  "cpf": "99999999999"
}

Observação: Os campos nome, email e cpf são obrigatórios.

2. Editar dados do Cliente

Endpoint: PUT /cliente/:id

Essa é a rota que permite o usuário realizar atualização de um cliente cadastrado.

Header:

Authorization: Bearer SEU_TOKEN

Corpo da requisição:

{
  "nome": "Nome do Cliente",
  "email": "[email protected]",
  "cpf": "99999999990",
  "cep": "99999999",
  "rua": "Rua teste",
  "numero": "99",
  "bairro": "Teste",
  "cidade": "Teste",
  "estado": "Teste"
}

OU

{
  "nome": "Nome do Cliente",
  "email": "[email protected]",
  "cpf": "99999999990"
}

Observação: Os campos nome, email e cpf são obrigatórios.

3. Listar Clientes

Endpoint: GET /cliente

Essa é a rota que será chamada quando o usuário logado quiser listar todos os clientes cadastrados.

Header:

Authorization: Bearer SEU_TOKEN

4. Detalhar Cliente

Endpoint: GET /cliente/:id

Essa é a rota que será chamada quando o usuário logado quiser obter um de seus clientes cadastrados.

Header:

Authorization: Bearer SEU_TOKEN

✅Endpoints de Pedidos

1. Cadastrar Pedido

Endpoint: POST /pedido

Essa é a rota que será utilizada para cadastrar um novo pedido no sistema.

Corpo da requisição:

{
    "cliente_id": 8,
    "observacao": "Em caso de ausência recomendo deixar com algum vizinho",
    "pedido_produtos": [
        {
            "produto_id": 18,
            "quantidade_produto": 2
        },
			        {
            "produto_id": 8,
            "quantidade_produto": 1
        }
    ]
}

Observação: todos os campos são obrigatórios.

Um e-mail é enviado para o cliente notificando que o pedido foi efetuado com sucesso.

2. Listar Pedidos

Endpoint: GET /pedido

Essa é a rota que será chamada quando o usuário logado quiser listar todos os pedidos cadastrados.

Header:

Authorization: Bearer SEU_TOKEN

Requisição:

Caso seja enviado o parâmetro do tipo query cliente_id, filtrar os pedidos de acordo com o cliente, caso o id do cliente informado exista.

Caso não seja informado o parâmetro do tipo query cliente_id todos os pedidos cadastrados deverão ser retornados.

📌Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

Server (NodeJS)

Express
CORS
bcrypt
jsonwebtoken
KnexJS
dotENV

Veja o arquivo package.json

Utilitários

Deploy: API
Editor: Visual Studio Code
Teste de API: Insomnia

Autoras

_{Daniela Felipe Soares}
👩‍💻

_{Gessyca Borges}
👩‍💻

_{Mirella Rebouças}
👩‍💻

_{Natalia Salles}
👩‍💻

_{Sara Webery}
👩‍💻

Name		Name	Last commit message	Last commit date
Latest commit History 303 Commits
assets		assets
src		src
.env.example		.env.example
.gitignore		.gitignore
README.md		README.md
package-lock.json		package-lock.json
package.json		package.json

GessycaBorges/pdv_shop_easy

Folders and files

Latest commit

History

Repository files navigation

Sistema de Ponto de Venda

📌Sobre o projeto

Acesso ao sistema:

📌Funcionalidades

📌Utilização

1. Listar categorias

✅Endpoints de Usuários

1. Cadastrar Usuário

Corpo da requisição:

Observação: todos os campos são obrigatórios.

2. Efetuar Login do Usuário

Corpo da requisição:

Observação: Após realizar o login com sucesso, um token será retornado. Esse token deve ser utilizado para autenticação nos próximos endpoints, pois eles são protegidos.

3. Detalhar Perfil do Usuário Logado

Header:

4. Editar Perfil do Usuário Logado

Header:

Corpo da requisição:

Observação: Todos os campos são obrigatórios.

✅Endpoints de Produtos

1. Cadastrar Produto

Header:

Corpo da requisição:

Observação: todos os campos são obrigatórios, exceto a imagem do produto.

2. Editar Dados do Produto

Header:

Corpo da requisição:

Observação: todos os campos são obrigatórios, exceto a imagem do produto.

3. Listar Produtos

Header:

Requisição:

4. Detalhar Produto

Header:

5. Excluir Produto por ID

Header:

✅Endpoints de Clientes

1. Cadastrar Cliente

Header:

Corpo da requisição:

Observação: Os campos nome, email e cpf são obrigatórios.

2. Editar dados do Cliente

Header:

Corpo da requisição:

Observação: Os campos nome, email e cpf são obrigatórios.

3. Listar Clientes

Header:

4. Detalhar Cliente

Header:

✅Endpoints de Pedidos

1. Cadastrar Pedido

Corpo da requisição:

Observação: todos os campos são obrigatórios.

2. Listar Pedidos

Header:

Requisição:

📌Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

Server (NodeJS)

Utilitários

Autoras

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Contributors 5

Languages

Packages