Put README.md
Browse files
README.md
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# HuntFlow
|
| 2 |
+
|
| 3 |
+
Job search copilot: live job aggregation, explainable match scoring, alerts, application packs, tracking and an autopilot queue.
|
| 4 |
+
|
| 5 |
+
## How the automation works
|
| 6 |
+
- `src/instrumentation.ts` starts a scheduler when the server boots: alerts + autopilot run every 30 min, job boards sync every 6 h.
|
| 7 |
+
- `POST /api/cron/run` triggers the same pipeline on demand (set `CRON_SECRET` to require `Authorization: Bearer <secret>`).
|
| 8 |
+
- Sources (no API keys needed): Remotive, Arbeitnow, RemoteOK, Himalayas (`src/lib/sources.ts`).
|
| 9 |
+
- Matching: `src/lib/match.ts` (role, skills, location/mode, seniority, pay).
|
| 10 |
+
- Autopilot never submits to employers; it prepares a pack (match report + cover letter) and queues it for one-click approval.
|
| 11 |
+
- Optional: `OPENAI_API_KEY` (+ `OPENAI_MODEL`) enables AI-written cover letters; otherwise a template writer is used.
|