/projeto-cptm-teste

[GRUPO X] Nome do Projeto

Integrantes

  • Pessoa 1: Scrum Master
  • Pessoa 2: Desenvolvimento
  • Pessoa 3: Desenvolvimento
  • Pessoa 4: Desenvolvimento
  • Pessoa 5: Desenvolvimento

1. Nome do Projeto: IbmecFood

Um aplicativo de gestão de pedidos em restaurantes.

2. Apresentação do Projeto

Este projeto é um sistema para automatizar a gestão de pedidos em restaurantes. Ele permite que os garçons enviem pedidos diretamente para a cozinha e o caixa, gerando relatórios em tempo real. O projeto foi pensado para pequenos e médios estabelecimentos que buscam maior agilidade no atendimento e controle sobre o fluxo de pedidos.

3. Gestão de Código

Este projeto utiliza as seguintes tecnologias e ferramentas:

  • Linguagens: HTML, CSS e JS
  • Framework: Bootstrap
  • Versionamento de código: Git

Padrão para nomes de branches

  • feature/: Usado para novas funcionalidades. Exemplo: feature/adicionar-login-social

  • bugfix/: Usado para correção de bugs. Exemplo: bugfix/corrigir-botao-de-envio

  • hotfix/: Usado para correções urgentes em produção. Exemplo: hotfix/corrigir-falha-autenticacao

  • chore/: Usado para pequenas tarefas ou atualizações técnicas que não afetam o código funcional. Exemplo: chore/atualizar-documentacao

Tipos de Commits

  • feat: Adição de uma nova funcionalidade. Exemplo: feat: implementar sistema de login com JWT

  • fix: Correção de bugs. Exemplo: fix: corrigir erro no cálculo de desconto

  • docs: Alterações na documentação. Exemplo: docs: atualizar README com instruções de instalação

  • style: Alterações de formatação e estilo (não afetam a lógica). Exemplo: style: ajustar espaçamento no arquivo CSS

  • refactor: Refatoração de código (melhorias sem adicionar novas funcionalidades). Exemplo: refactor: otimizar função de busca

  • test: Adição ou correção de testes. Exemplo: test: adicionar testes unitários para componente Header

  • chore: Atualizações gerais que não alteram código funcional (ex: atualizações de dependências). Exemplo: chore: atualizar pacotes NPM

4. Organização de Pastas e Arquivos

  • /src: Contém o código fonte do projeto.
    • /content: Arquivos HTML.
    • /css: Folhas de estilo CSS.
    • /js: Arquivos JS.
    • /img: Imagens.
  • /docs: Documentação do projeto.

5. Requisitos Funcionais

  1. Cadastro de Usuários: Permite o registro de novos usuários (admin e funcionários).
  2. Gestão de Pedidos: Garçons podem adicionar, editar e excluir pedidos.
  3. Relatórios: O sistema gera relatórios de pedidos por dia e por período.
  4. Integração com Cozinha: Notificações em tempo real para a cozinha quando um pedido é enviado.
  5. Login e Autenticação: Sistema seguro de login com autenticação JWT.

Esse modelo pode ser adaptado para diversos tipos de projetos. A clareza e a organização são essenciais para facilitar o entendimento e a colaboração de novos desenvolvedores.