Skip to content

Commit a38535e

Browse files
authored
feat: add Electron desktop app setup and usage instructions to README (#21)
2 parents 83577c2 + 3373953 commit a38535e

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,66 @@ npm run dev:backend
114114
- `npm run test`: testes com Vitest
115115
- `npm run test:coverage`: coverage com Vitest
116116

117+
## Aplicativo Desktop (Electron)
118+
119+
O projeto tambem pode ser executado como app desktop Windows, sem precisar subir Docker no computador do usuario final.
120+
121+
### Como o app funciona
122+
123+
- O Electron inicia o backend internamente na porta `3001`
124+
- A UI React e carregada dentro da janela desktop
125+
- O botao **Buscar vagas** dispara o scraper via API (`POST /api/scraper/run`)
126+
- Os arquivos de saida (XLSX/PDF) sao salvos no diretorio de dados do usuario
127+
128+
### Estrutura principal
129+
130+
```text
131+
electron/
132+
├─ main.js
133+
├─ preload.js
134+
└─ loading.html
135+
```
136+
137+
### Rodar em modo desktop (desenvolvimento)
138+
139+
1. Instale dependencias na raiz:
140+
141+
```bash
142+
npm install
143+
```
144+
145+
2. Gere o build do frontend:
146+
147+
```bash
148+
npm run build:frontend
149+
```
150+
151+
3. Inicie o app Electron:
152+
153+
```bash
154+
npm run electron
155+
```
156+
157+
Opcional (atalho para build + electron):
158+
159+
```bash
160+
npm run electron:dev
161+
```
162+
163+
### Gerar instalador .exe para distribuir
164+
165+
Execute na raiz do monorepo:
166+
167+
```bash
168+
npm run dist
169+
```
170+
171+
O instalador sera gerado em `dist-electron/` (target `nsis`).
172+
173+
### Observacao para Windows (build local)
174+
175+
Se o `electron-builder` falhar com erro de symlink (winCodeSign), habilite o **Modo de Desenvolvedor** no Windows ou rode o terminal como Administrador antes de executar `npm run dist`.
176+
117177
## Testes e cobertura
118178

119179
Estrutura de testes:

0 commit comments

Comments
 (0)