Giter Club home page Giter Club logo

mono-central-de-pedidos's Introduction

Central de Pedidos (Monorepo)

Este é um monorepo para o projeto de Central de Pedidos. Aqui você encontrará todos os componentes e serviços necessários para a implementação do sistema.

Escopo

Aplicação Web

  • Pagina de criação de pedidos (Cliente)
  • Pagina de gerencia de pedidos (Funcionário)
    • Visualização.
    • Marcar um pedido como pronto.
    • Marcar um pedido como entregue
    • Novos pedidos devem chegar em tempo real.
  • Pagina de painel de senha (Cliente e TV)
    • ex: https://painelsenha.grupomadero.com.br/painel
    • Visualização dos números de pedidos prontos e preparando.
    • No mobile é ideal que não precise rolar a tela
    • Novos pedidos devem chegar em tempo real.
    • Pedidos entregues devem mudar de cor no painel e ficar com menos destaque

API

Especificação da API REST

A API REST fornece acesso aos recursos do sistema de forma simples e intuitiva. A seguir, são descritas as rotas disponíveis na API.

Endpoints

Recursos de pedidos

  • GET /api/orders - Lista todos os pedidos do sistema
  • POST /api/orders - Cria um novo pedido
  • PUT /api/order-status/:id - Atualiza o status de um pedido (CRIADO, PREPARANDO, PRONTO, ENTREGUE)

Recursos de tempo real

  • SSE /api/orders-stream - Este endpoint fornece uma stream de eventos das atualização de pedidos em tempo real.

Requisições

Request Headers

  • Content-Type: application/json: Indica que o corpo da requisição é um objeto JSON.

Request Body

{
    "keyx": "valorx",
    // ...
}

Repostas

Erro: (HTTP >= 400)

{
  "message": "Descrição do erro"
}

Estrutura de pastas

  • /client: Contém o código fonte da aplicação cliente (React).
  • /server: Contém o código fonte do servidor (Node.js).

mono-central-de-pedidos's People

Contributors

guilhermerodrigues680 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.