Sistema de Gestão de Restaurantes (RMS) desenvolvido pelo grupo "BOPE" G03 da turma 4SOAT para o Tech Challenge da Pós Tech em Software Architecture da FIAP.
Warning
Essa aplicação monolítica foi decomposta em microsserviços e não será mais mantida, nem receberá novas funcionalidades. Visite a página da organização no GitHub para visualizar todos os microsserviços.
Há uma lanchonete de bairro que está expandindo devido seu grande sucesso. Porém, com a expansão e sem um sistema de controle de pedidos, o atendimento aos clientes pode ser caótico e confuso. Por exemplo, imagine que um cliente faça um pedido complexo, como um hambúrguer personalizado com ingredientes específicos, acompanhado de batatas fritas e uma bebida. O atendente pode anotar o pedido em um papel e entregá-lo à cozinha, mas não há garantia de que o pedido será preparado corretamente.
Sem um sistema de controle de pedidos, pode haver confusão entre os atendentes e a cozinha, resultando em atrasos na preparação e entrega dos pedidos. Os pedidos podem ser perdidos, mal interpretados ou esquecidos, levando à insatisfação dos clientes e a perda de negócios.
Em resumo, um sistema de controle de pedidos é essencial para garantir que a lanchonete possa atender os clientes de maneira eficiente, gerenciando seus pedidos e estoques de forma adequada. Sem ele, expandir a lanchonete pode acabar não dando certo, resultando em clientes insatisfeitos e impactando os negócios de forma negativa.
Para solucionar o problema, a lanchonete irá investir em um sistema de autoatendimento de fast food, que é composto por uma série de dispositivos e interfaces que permitem aos clientes selecionar e fazer pedidos sem precisar interagir com um atendente.
— Fonte: FIAP
- Baixe e instale o Node.js em https://nodejs.org/en/download
- Instale o CLI do NestJS através do comando
npm i -g @nestjs/cli
- Navegue até a pasta raiz do projeto usando o Terminal;
- Faça uma cópia do arquivo
.env.template
com o nome.env
e preencha as variáveis de ambiente dentro dele; - Execute o comando
npm install
para instalar os pacotes npm; - Use o comando
npm run start
para iniciar a aplicação. - Execute o comando
docker-compose up -d db
para iniciar o container do banco de dados; - Acesse o Swagger em http://localhost:3000/swagger/
Como executar a aplicação usando o Docker Compose?
- Clone este repositório;
- Navegue até a pasta raiz do projeto usando o Terminal;
- Faça uma cópia do arquivo
.env.template
com o nome.env
e preencha as variáveis de ambiente dentro dele; - Execute o comando
docker-compose up
- Acesse o Swagger em http://localhost:3000/swagger/
Como executar a aplicação usando o Kubernetes do Docker Desktop?
- Clone este repositório;
- Navegue até a pasta raiz do projeto usando o Terminal;
- Use o comando
docker build -t rms-api-monolito:latest .
para gerar a imagem de container da aplicação; - Use o comando
kubectl apply -f k8s/development/postgres/namespace.yaml -f k8s/development/postgres/pvc-pv.yaml -f k8s/development/postgres/config.yaml -f k8s/development/postgres/secrets.yaml -f k8s/development/postgres/deployment.yaml -f k8s/development/postgres/service.yaml
para fazer deploy do banco de dados; - Use o comando
kubectl apply -f k8s/development/bff/namespace.yaml -f k8s/development/bff/config.yaml -f k8s/development/bff/secrets.yaml -f k8s/development/bff/deployment.yaml -f k8s/development/bff/service.yaml -f k8s/development/bff/hpa.yaml
para fazer deploy da aplicação; - Acesse o Swagger em http://localhost:3000/swagger/
Para remover a aplicação do Kubernetes, use o comando
kubectl delete namespace rms
Em seu ambiente de desenvolvimento, por questão de segurança, abra os arquivos /k8s/development/postgres/secrets.yaml
e /k8s/development/bff/secrets.yaml
na pasta /k8s/development
e preencha os valores sensíveis manualmente.
No ambiente de produção os Secrets do Kubernetes são gerenciados pelo AWS Secrets Manager.
Para mais informações visite a página Boas práticas para secrets do Kubernetes.
Como testar o pagamento de pedidos através do QR Code do Mercado Pago?
Para testar o pagamento de pedidos usando o QR Code do Mercado Pago você vai precisar criar uma Aplicação no portal do Mercado Pago Developers.
- Siga as instruções na página Pré-requisitos no Mercado Pago Developers;
- Após criar as contas de teste do
Vendedor
e doComprador
, abra uma janela anônima (Ctrl + Shift + P) no navegador e faça login no portal do Mercado Pago Developers usando o usuário e senha da conta de teste do Vendedor; - Após fazer login no portal do Mercado Pago Developers usando o usuário e senha da conta de teste do Vendedor, crie uma aplicação de testes dento da conta de testes do Vendedor.
- Anote o
User ID
que aparece em baixo de "Detalhes da aplicação" na página inicial da aplicação de testes dentro da conta de testes do Vendedor; - Clique em "Credenciais de teste" no menu do lado esquerdo da tela e anote o
Access Token
da aplicação de testes; - Usando o Postman, cadastre uma Loja conforme instruções na página Criar loja. Anote o
id
da Loja que você cadastrou; - Usando o Postman, cadastre um Caixa conforme instruções na página Criar caixa. Anote o
external_id
do Caixa que você cadastrou; - Preencha as variáveis de ambiente no arquivo
.env
com oUser ID
eAccess Token
da aplicação de testes e com oid
da Loja e oexternal_id
do Caixa que você de cadastrou anteriormente através da API do Mercado Pago; - Ative a feature flag
ENABLE_MERCADOPAGO=true
no arquivo.env
- Execute a aplicação.
Você pode conectar-se a instância de banco de dados PostgreSQL usando o pgAdmin, o terminal através do psql, ou qualquer outra IDE ou ferramenta compatível.
Quais são os parâmetros da conexão e credenciais para acesso ao banco de dados PostgreSQL?
Host: localhost
Porta: 5432 (padrão)
Usuário: pguser
Senha: pgpwd
DB name: rms
A documentação do projeto está disponível no GitHub Wiki.
Architectural Pattern: Clean Architecture + Screaming Architecture
Clique na imagem para ampliar.
Cloud provider: AWS
Clique na imagem para ampliar.
Para contribuir com o projeto consulte o guia em CONTRIBUTING.md
$ npm install
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
Amazon Cognito Lambda triggers
https://github.com/Grupo-G03-4SOAT-FIAP/rms-cognito-triggers
Infrastructure as code (IaC) com Terraform
https://github.com/Grupo-G03-4SOAT-FIAP/rms-iac
Node.js v20.12.0 (LTS), Docker Desktop 24.0.6 e Kubernetes v1.28
Pagamentos processados por Mercado Pago.