Documentação do Projeto Cardápio Digital

Autor(a): Fernanda Amaral de Souza

 Sumário

1. INTRODUÇÃO
1.1 DESCRIÇÃO DO PROBLEMA
1.2 ESCOPO DE SOFTWARE

2. REQUISITOS
2.1 REQUISITOS NÃO FUNCIONAIS
2.2 REQUISITOS FUNCIONAIS

3. DESCRIÇÃO GERAL
3.1 PERSPECTIVA DO PRODUTO
2.2 REQUISITOS FUNCIONAIS

4. CASOS DE USO
4.1 UC01 – CASO DE USO CARDÁPIO DIGITAL

5. LINGUAGENS E PROGRAMAS UTILIZADOS

5.1 LINGUAGENS FRONT-END
5.2 LINGUAGENS BACK-END
5.3 FRAMEWORKS E BIBLIOTECAS
5.4 PROGRAMAS UTILIZADOS

6. COMO INICIAR O CÓDIGO

6.1 DESCRIÇÃO PARA INICIAR O CÓDIGO
1. Introdução

1.1 Descrição do Problema

O setor de nutrição tem uma demanda todos os dias de entregar o almoço dos
médicos e anestesistas que atuam no Hospital. Atualmente não existe um programa
para efetuar o controle de pedidos e informações relacionadas e não é possível
armazenar o histórico de pedidos para relatórios e melhorias futuras.

1.2 Escopo de software

Esse documento apresenta os requisitos do Cardápio Digital.
O sistema tem como objetivo:
-> Permitir que os pratos sejam registrados e armazenados e tenham um histórico para
relatórios e melhorias futuras;
-> Permitir que o administrador ative e desative os pratos para efetuar o controle de
acordo com os alimentos fornecidos e cardápio;
-> Permite que o médico ou anestesista efetue o pedido somente com o CPF.

2. Requisitos

2.1 Requisitos Não-Funcionais

• Segurança
- O sistema deve garantir a segurança dos dados dos usuários, especialmente ao lidar
com informações sensíveis, como CPFs.

• Confiabilidade
- O tempo de resposta do sistema deve ser rápido para oferecer uma experiência
eficiente ao usuário durante a validação do CPF e a consulta ao banco de dados.

• Escalabilidade
- O sistema deve ser robusto, minimizando falhas durante a validação do CPF, consulta
ao banco de dados e armazenamento dos pedidos.

• Usabilidade
- O software deve ser projetado para lidar com o aumento no número de pedidos sem
comprometer sua eficiência ou desempenho.

• Manutenibilidade
- A interface do usuário deve ser amigável e de fácil compreensão para permitir que os
usuários naveguem facilmente pelo sistema.
2.2 Requisitos Funcionais
• Validação do CPF
- O sistema deve permitir que o usuário insira um CPF.

• Verificação no Banco de Dados

- Após inserir o CPF, o sistema deve consultar o banco de dados para verificar se o CPF
existe. Caso o CPF seja válido e exista no banco de dados, o sistema permitirá o acesso
ao menu.

• Redirecionamento para o Menu

- Após a validação do CPF e a confirmação da existência no banco de dados para o dia
atual, o usuário deve ser redirecionado para o menu.

• Escolha de Prato
- No menu, o usuário deve poder escolher um prato disponível. O sistema deve
permitir apenas a escolha de um prato por pedido.

• Envio do Pedido
-Após a seleção do prato, o usuário deve poder enviar o pedido. O sistema deverá
armazenar esse pedido no banco de dados.

3. Descrição Geral

3.1 Perspectiva do Produto

O código depende do Anaconda Prompt, contendo as bibliotecas necessárias para seu
funcionamento, e do Visual Studio Code para manutenções futuras e visualização do
código no servidor alocado. Nos tópicos seguintes, fornecerei mais detalhes sobre
como efetuar o funcionamento do código.

3.2 Postergar Requisitos

Caso o código não funcione corretamente, uma das soluções poderá ser atualizar as
bibliotecas dependentes que são utilizadas no código.
4. Casos de Uso

4.1 UC01 - Caso de Uso Cardápio Digital

Objetivo: O objetivo deste caso de uso é descrever o processo pelo qual o sistema valida o CPF
do usuário. Se o CPF fornecido for válido e não tiver sido utilizado no dia corrente, o sistema
permite que o usuário avance para selecionar os pratos desejados. Após a seleção dos pratos
por meio de checkboxes, quando o usuário clicar em "Enviar", os dados são armazenados de
forma segura no banco de dados.

Este caso de uso visa garantir uma interação eficiente e segura entre o usuário e o sistema,
assegurando que apenas usuários válidos e não duplicados possam realizar seleções de pratos,
e que essas seleções sejam registradas adequadamente para posterior uso e análise.
5. Linguagens e Programas Utilizados

5.1 Linguagens Front-End

HTML CSS JavaScript

5.2 Linguagens Back-End

Python

5.3 Frameworks e Bibliotecas

FastAPI Cx_Oracle Uvicorn

Pydantic Sqlite

5.4 Programas Utilizados

Anaconda Navigator Visual Studio Code

Link para download:

https://docs.anaconda.com/free/navigator/index.html

https://code.visualstudio.com/Download
6. Como iniciar o código

6.1 Descrição para iniciar o código

Para iniciar o programa, é necessário garantir a instalação de todas as bibliotecas no Anaconda
Prompt. Uma vez verificado que as bibliotecas estão instaladas, o programa pode ser iniciado
utilizando a seguinte linha de código:

uvicorn nome_do_arquivo:app --host 0.0.0.0 --port 0000

Para realizar manutenções no código, é necessário o uso do Anaconda Navigator. Dentro do

Anaconda Navigator, o Visual Studio Code está disponível para uso. Basta abrir o Visual Studio
Code e navegar até a pasta onde o código está localizado, juntamente com todas as pastas
necessárias para seu funcionamento.

Este procedimento assegura um ambiente adequado para o desenvolvimento, execução e

manutenção do código de forma eficiente e organizada.