From 3b18a4906b5801ca7ecbe80facefc4479231689c Mon Sep 17 00:00:00 2001 From: kl3z Date: Mon, 24 Aug 2026 21:41:42 +0000 Subject: [PATCH] Modificar README.md --- README.md | 144 ++---------------------------------------------------- 1 file changed, 3 insertions(+), 141 deletions(-) diff --git a/README.md b/README.md index d7148579..1b0784d0 100644 --- a/README.md +++ b/README.md @@ -133,12 +133,12 @@ python -m pip install pandas camelot-py PyMuPDF pytesseract Pillow openpyxl ## Instalação ```bash -git clone +git clone http://192.168.1.39:3001/kl3z/Metacase.git cd form_metacase npm ci ``` -## Configuração +## Configuração (no meu Servidor aqui a Arquitetura e as configurações dependem da construções e das caracteristicas que quiserem colocar) | Variável | Predefinição | Descrição | | --- | --- | --- | @@ -152,148 +152,10 @@ npm ci | `CONVERTER_TIMEOUT_MS` | `600000` | Timeout de conversão. | | `CONVERTER_MAX_UPLOAD_BYTES` | `26214400` | Limite do PDF, por defeito 25 MB. | -Exemplo em PowerShell: -```powershell -$env:AUTH_TOKEN_SECRET = 'substituir-por-um-segredo-longo-e-aleatorio' -$env:BOT_SIBS_API_URL = 'http://127.0.0.1:8000' -$env:LIBRETRANSLATE_URL = 'http://127.0.0.1:5000' -$env:PYTHON_BIN = 'python' -``` - -> Nunca utilize o valor predefinido de `AUTH_TOKEN_SECRET` em produção. Não guarde segredos, tokens ou credenciais no repositório. - -## Desenvolvimento - -Inicie a API num terminal: - -```bash -npm run api -``` - -Inicie o Angular noutro terminal: - -```bash -npm start -``` - -A aplicação fica disponível em `http://localhost:4200`. O proxy de desenvolvimento encaminha `/api` para `http://127.0.0.1:3000`. - -## Build e execução - -```bash -npm run build -npm run serve:auth -``` - -A aplicação compilada e a API ficam disponíveis em `http://localhost:3000`. - -### Scripts npm - -| Comando | Descrição | -| --- | --- | -| `npm start` | Angular em desenvolvimento com proxy para a API. | -| `npm run api` | Apenas a API Node.js. | -| `npm run serve:auth` | API e build Angular no mesmo servidor. | -| `npm run build` | Build de produção em `dist/`. | -| `npm run watch` | Build de desenvolvimento em modo watch. | -| `npm test` | Testes unitários com Vitest. | - -## API - -| Método | Endpoint | Função | -| --- | --- | --- | -| `POST` | `/api/login` | Valida credenciais e cria a sessão. | -| `GET` | `/api/session` | Valida o token atual. | -| `POST` | `/api/vitoria-ai/perguntar` | Encaminha uma pergunta para a Vitoria AI. | -| `POST` | `/api/tradutor/traduzir` | Traduz texto através do LibreTranslate. | -| `POST` | `/api/conversor-extratos/executar` | Converte um PDF em Excel. | - -O conversor recebe o PDF no corpo binário e utiliza: - -- `X-Bank-Key`: banco (`abanca` ou `bic`). -- `X-File-Name`: nome original do PDF. ## Utilizadores Os utilizadores locais são mantidos em `server/users.json`, com nome, email, estado, salt e hash da palavra-passe. Não devem ser guardadas palavras-passe em texto simples. -Para produção ou utilização em maior escala, recomenda-se uma base de dados ou um fornecedor de identidade corporativo. - -## Docker - -```bash -AUTH_TOKEN_SECRET= docker compose up --build -``` - -Para alterar a porta publicada: - -```bash -APP_PORT=8080 AUTH_TOKEN_SECRET= docker compose up --build -``` - -> A imagem atual contém o frontend e o servidor Node.js. Para executar os conversores no contentor, é ainda necessário incluir Python, a pasta `Metacase` e as respetivas dependências na imagem de runtime, ou separar a conversão num serviço próprio. - -O exemplo em `deploy/nginx/form_metacase.conf` encaminha pedidos para a porta `3000` e aceita uploads até 30 MB. - -## Testes - -```bash -npm test -npm run build -``` - -Antes de integrar alterações, valide também os fluxos de login, formação, IA, tradução, conversão e Power BI. - -## Resolução de problemas - -### A API não responde - -- Confirme que `npm run api` está ativo. -- Verifique a porta `3000` e `proxy.conf.json`. -- Confirme `BOT_SIBS_API_URL` e `LIBRETRANSLATE_URL`. - -### O Power BI não aparece - -- Inicie sessão na conta Microsoft correta. -- Confirme que a conta tem acesso ao relatório. -- Permita pop-ups e cookies necessários ao Power BI. -- Valide o URL `reportEmbed` em `report-creator-page.ts`. - -### A conversão falha - -- Confirme que o PDF é válido e não excede o limite. -- Verifique `PYTHON_BIN` e `CONVERTERS_DIR`. -- Instale as bibliotecas Python, o Tesseract e as dependências do Camelot. - -### O tradutor não responde - -- Confirme que o LibreTranslate está acessível pelo servidor Node.js. -- Verifique `LIBRETRANSLATE_URL` e o endpoint `/translate`. - -## Segurança - -Antes de produção: - -- utilize um segredo de autenticação forte; -- proteja todos os endpoints sensíveis; -- restrinja CORS e o acesso à rede; -- utilize HTTPS e headers de segurança; -- não faça commit de `.env`, credenciais ou dados bancários; -- mantenha dependências atualizadas; -- configure logs e auditoria sem informação sensível. - -## Contribuição no Gitea - -1. Crie um ramo a partir do ramo principal. -2. Faça alterações pequenas e focadas. -3. Execute testes e build. -4. Confirme que não adicionou segredos ou dados sensíveis. -5. Abra um Pull Request no Gitea com a descrição e evidências de validação. - -```bash -git checkout -b feature/nome-da-funcionalidade -git add . -git commit -m "feat: descrição da alteração" -git push origin feature/nome-da-funcionalidade -``` +Para produção ou utilização em maior escala, recomenda-se uma base de dados ou um fornecedor de identidade corporativo. Por exemplo weviate