Sintese System - Backend

Observação: todos os comandos devem ser executados a partir da pasta sintese_system/backend.

cd backend

Instruções de Configuração

Criar e ativar o ambiente virtual

No terminal (do Command Prompt Line), execute:

python -m venv .venv
.venv\Scripts\activate.bat

Depois, instale as seguintes bibliotecas:

pip install fastapi uvicorn sqlalchemy passlib[bcrypt] python-jose[cryptography] python-dotenv python-multipart psycopg2

Criar variáveis de ambiente

Crie um arquivo na pasta backend com o nome .env, e preencha os seguintes campos:

HOST=localhost
USER=[seu usuário no postgre]
PASSWORD=[sua senha no postgre]
PORT=[a porta no qual o servidor do postgre roda, geralmente 5432]
DATABASE=[nome da database na qual deseja trabalhar]

Instruções de Uso

Ativando ambiente virtal

Caso você não esteja no ambiente virtual, execute:

python -m venv .venv
.venv\Scripts\activate.bat

Rodando servidor

No terminal, rode o seguinte comando:

uvicorn main:app --reload

Se ocorreu bem, uma mensagem semelhante à essa deve aparecer:

INFO: Will watch for changes in these directories: ['[...]\\sintese_system\\backend'] 
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) 
INFO: Started reloader process [21152] using StatReload 
INFO: Started server process [9936] 
INFO: Waiting for application startup. 
INFO: Application startup complete. 

Acessando serviço:

Copie o link da mensagem anterior e cole no seu navegador adicionando o caminho /docs:

http://127.0.0.1:8000/docs 

Após isso use a interface do FastAPI para testar requisições e suas respectivas repostas.

Desativar ambiente virtual:

Para desativar o ambiente virtual, basta usar esse comando no terminal Command Prompt Line:

.venv\Scripts\deactivate.bat

Sintese System - Frontend

Observação: todos os comandos devem ser executados a partir da pasta sintese_system/frontend.

cd frontend

Requisitos

Para rodar a aplicação, é necessário Node.js em uma versão compatível com o Vite, sendo elas 20.19+ ou 22.12+.

Instruções de Configuração

Para configurar cesse a pasta da aplicação:

cd application

Depois, instale as dependencias a partir do comado:

npm install

Instruções de Uso

Inicializar e acessar aplicação

Acesse o diretório da aplicação no terminal e execute os comandos:

cd frontend/application
npm run dev

A saída deve ser semelhante a essa:

application@0.0.0 dev vite

18:51:34 [vite] (client) Re-optimizing dependencies because lockfile has changed

VITE v7.1.12 ready in 668 ms

➜ Local: http://localhost:5173/ ➜ Network: use --host to expose ➜ press h + enter to show help

Para acessar o serviço, basta clicar no link indicado por '➜ Local' ou copiar o link http://localhost:5173/ e colá-lo no seu navegador.

Sair da Aplicação

Precione Ctrl + C no terminal e irá aparecer a seguinte mesagem:

"Deseja finalizar o arquivo em lotes (S/N)?"

Pressione S e depois Enter para fechar a aplicação.

Importante

A aplicação necessita que o backend já esteja rodando para se comunicar com a Base de Dados no PostgreSQL.