c4749b4211
* feat(demo): add DEMO_MODE runtime helpers and /api/demo/info endpoint * feat(demo): enforce simulated and blocked API actions under DEMO_MODE * feat(demo): add deterministic seed dataset and 6-hour auto-reset * feat(demo-ui): add demo banner and custom sonner toasts for simulated/blocked actions * test+docs(demo): add demo mode coverage, behavior matrix, and operator docs * formatting * tests * feat(demo): seed resets from typed baseline defaults * formatting * feat(demo): enrich baseline seed data and demo project catalog * feat(demo): expand seeded applications and chart time ranges * refactor(demo): split demo seed data from generation logic * feat(demo): cap generated application history to 30 days * feat(demo): rebalance generated job status distribution * feat(demo-ui): make demo banner fixed and topmost * minor fixes * formatting * duration revert * durations * feat(demo): share demo info hook, brighten demo toasts, and enforce webhook auth * comment explaning * formatting * comments * deadline builder comment
115 lines
4.6 KiB
Markdown
115 lines
4.6 KiB
Markdown
# JobOps
|
|
|
|
AI-powered job discovery and application pipeline. Automatically finds jobs, scores them against your profile, and generates tailored resumes.
|
|
|
|
## Workflow
|
|
1. **Search**: Scrapes Gradcracker, Indeed, LinkedIn, and UK Visa Sponsorship jobs.
|
|
2. **Score**: AI ranks jobs by suitability using the configured LLM provider (OpenRouter by default).
|
|
3. **Tailor**: Generates a custom resume summary for top-tier matches.
|
|
4. **Export**: Uses [RxResume v4](https://v4.rxresu.me) to create tailored PDFs.
|
|
5. **Manage**: Review and mark jobs as "Applied" via the dashboard (syncs to Notion).
|
|
|
|
## Example of generating a tailored resume for a job
|
|
https://github.com/user-attachments/assets/5b9157a9-13b0-4ec6-9bd2-a39dbc2b11c5
|
|
|
|
## Example of applying to a Ready job
|
|
https://github.com/user-attachments/assets/06e5e782-47f5-42d0-8b28-b89102d7ea1b
|
|
|
|
## Quick Start
|
|
```bash
|
|
# 1. Clone and move to directory
|
|
git clone https://github.com/DaKheera47/job-ops.git
|
|
cd job-ops
|
|
|
|
# 2. Start with Docker (pulls pre-built image from GHCR)
|
|
docker compose up -d
|
|
|
|
# 3. Open the dashboard, the app will onboard your credentials
|
|
open http://localhost:3005
|
|
```
|
|
|
|
The app will guide you through setup on first launch. The onboarding wizard helps you:
|
|
- Configure the LLM provider (OpenRouter by default) and add an API key if required (for AI scoring/tailoring)
|
|
- Add your RxResume credentials (for PDF export via v4.rxresu.me)
|
|
- Select a template resume from your v4.rxresu.me account
|
|
|
|
Note: `OPENROUTER_API_KEY` is deprecated. Existing OpenRouter keys are automatically migrated/copied to `LLM_API_KEY` on upgrade. Other providers are also supported.
|
|
|
|
## Structure
|
|
- `/orchestrator`: React frontend + Node.js backend & pipeline.
|
|
- `/extractors`: Specialized scrapers (Gradcracker, JobSpy, UKVisaJobs).
|
|
- `/data`: Persistent storage for SQLite DB and generated PDFs.
|
|
|
|
Technical breakdowns here: `documentation/extractors/README.md`
|
|
Orchestrator docs here: `documentation/orchestrator.md`
|
|
|
|
## Read-only mode (Basic Auth)
|
|
|
|
You can make the app read-only for the public by setting a username and password in the **Settings** page.
|
|
After this, all write actions (POST/PATCH/DELETE) require Basic Auth; browsing and viewing remain public.
|
|
|
|
Persistent data lives in `./data` (bind-mounted into the container).
|
|
|
|
## Public Demo Mode
|
|
|
|
Set `DEMO_MODE=true` to run an opinionated public demo experience.
|
|
|
|
- Works: browsing jobs, filtering, stage updates, and local demo DB changes.
|
|
- Simulated: pipeline run, summarize/process/rescore/pdf/apply flows, onboarding validation.
|
|
- Blocked: settings writes, database clear, backup create/delete, and status bulk-delete.
|
|
- Reset policy: demo dataset automatically resets every 6 hours.
|
|
|
|
Demo responses include request metadata and may include:
|
|
- `meta.simulated=true` for simulated actions
|
|
- `meta.blockedReason` for blocked actions
|
|
|
|
## Running (local dev)
|
|
|
|
Prereqs: Node 20+, Python 3.10+, Playwright browsers (Firefox).
|
|
|
|
Install Node deps (both packages):
|
|
|
|
```bash
|
|
cd orchestrator && npm install
|
|
cd ../extractors/gradcracker && npm install
|
|
```
|
|
|
|
Configure the orchestrator env + DB:
|
|
|
|
```bash
|
|
cd ../orchestrator
|
|
cp .env.example .env
|
|
npm run db:migrate
|
|
npm run dev
|
|
```
|
|
|
|
Dev URLs:
|
|
- API: `http://localhost:3001/api`
|
|
- UI (Vite): `http://localhost:5173`
|
|
|
|
## Notes / sharp edges
|
|
|
|
- **Crawl targets**: edit `extractors/gradcracker/src/main.ts` to change the Gradcracker location/role matrix.
|
|
- **Pipeline config knobs**: `POST /api/pipeline/run` accepts `{ topN, minSuitabilityScore }`; `PIPELINE_TOP_N`/`PIPELINE_MIN_SCORE` are used by `npm run pipeline:run` (CLI runner).
|
|
- **Anti-bot reality**: crawling is headless + "humanized", but sites can still block; expect occasional flakiness.
|
|
|
|
Note on Analytics: The current alpha version includes anonymous analytics (Umami) to help me debug performance. This will be made opt-in only in the upcoming updates. If you want to disable it now, block umami.dakheera47.com in your firewall.
|
|
|
|
# Contact
|
|
|
|
If you need any help with any step of the process, feel free to open an [issue](https://github.com/DaKheera47/job-ops/issues). I am actively monitoring this section and I would be extremely happy to help you get up and running!
|
|
|
|
## Star History
|
|
|
|
<a href="https://www.star-history.com/#DaKheera47/job-ops&type=date&legend=top-left">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=DaKheera47/job-ops&type=date&theme=dark&legend=top-left" />
|
|
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=DaKheera47/job-ops&type=date&legend=top-left" />
|
|
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=DaKheera47/job-ops&type=date&legend=top-left" />
|
|
</picture>
|
|
</a>
|
|
|
|
## License
|
|
|
|
AGPLv3
|