Skip to content

Commit

Permalink
Atualizar README
Browse files Browse the repository at this point in the history
  • Loading branch information
matheusdealcantara committed Dec 10, 2024
1 parent 24406eb commit d6e899f
Showing 1 changed file with 90 additions and 2 deletions.
92 changes: 90 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,90 @@
# template-repository
repositório de template
# 2024.2 Sagittarius - Sistema de Vendas

# Sistema de Gestão para a Empresa Frango Assado Pele Dourada

## Sobre o Projeto

Este projeto tem como objetivo desenvolver um **sistema interno de gestão** para a empresa *Frango Assado Pele Dourada*. O software busca integrar e automatizar as operações diárias da loja, como controle de vendas, encomendas, estoque, cadastro de clientes e fluxo de caixa. A solução foi projetada para atender às necessidades específicas do setor alimentício, proporcionando maior eficiência, organização e redução de erros operacionais.

---

## Funcionalidades Principais

1. **Gestão de Vendas e Encomendas**
- Registro de vendas no balcão com atualização automática do estoque.
- Cadastro de encomendas com informações detalhadas (cliente, horário, quantidade).
- Alertas para encomendas atrasadas e opção de entrega ou retirada.

2. **Controle de Estoque**
- Registro diário da quantidade de produtos disponíveis.
- Atualização automática do estoque com base em vendas e encomendas.
- Cadastro e edição de novos produtos.

3. **Cadastro de Clientes**
- Registro das informações dos clientes (nome, telefone e endereço).
- Edição ou exclusão dos dados cadastrados.

4. **Controle de Caixa**
- Registro de entradas e saídas financeiras com descrição, valor e data.
- Geração de saldo diário consolidado.
- Relatórios detalhados sobre vendas por métodos de pagamento (cartão débito/crédito).

5. **Dashboard Geral**
- Visão geral do desempenho mensal (vendas, encomendas, estoque).
- Gráficos e indicadores visuais para análise rápida.

6. **Autenticação**
- Tela de login com nome de usuário e senha para garantir a segurança dos dados.

---

## Tecnologias Utilizadas

- **Frontend**: HTML, CSS, JavaScript (com Bootstrap).
- **Backend**: Node.js com NestJS e Express.
- **Banco de Dados**: MongoDB.
- **Ferramentas**:
- **GitHub**: Controle de versão.
- **Figma**: Prototipação da interface do usuário.
- **Discord**: Comunicação entre os membros da equipe.
- **Miro**: Organização visual das tarefas (Kanban).
- **Docker**: Ambiente local para desenvolvimento.

---

## Metodologia

O desenvolvimento do projeto segue uma abordagem ágil combinando elementos do **SCRUM** e do **XP (Extreme Programming)**:

- **SCRUM**:
- Sprints semanais para entregas incrementais.
- Planejamento, checkpoints e retrospectivas regulares.
- **XP**:
- Programação em pares (Pair Programming).
- Integração contínua para evitar falhas no sistema.
- Refatoração constante para manter o código limpo e eficiente.

---

## Equipe

| Matrícula | Nome | Função |
|:-------------:|:------------------------------------:|:--------------------------:|
| 231026509 | Matheus de Alcântara | Back-end / Banco de Dados |
| 231026590 | Vilmar José Fagundes dos Passos Jr. | Back-end / Banco de Dados |
| 222015159 | Lucas Guimarães Borges | Back-end |
| 222006150 | Micael Kauan Freitas Chagas | Front-end |
| 231026358 | Gabriel Flores Coelho | Banco de Dados |
| 221007635 | André Gustavo Rabelo do Nascimento | Front-end |
| 231026400 | João Victor Pires Sapiência Santos | Back-end |
| 231026302 | Caio Lucas Messias Sabino | Back-end |
| 221008196 | João Victor Sousa Soares e Silva | Front-end |
| 222022082 | Fábio Santos Araújo | Banco de Dados |

---

## Como Contribuir

1. Clone o repositório:
```bash
git clone <URL_DO_REPOSITORIO>

0 comments on commit d6e899f

Please sign in to comment.