Readme updates

This commit is contained in:
DaKheera47 2026-01-23 13:11:34 +00:00
parent 1ba3d25881
commit ba9beaf01e
4 changed files with 16 additions and 28 deletions

View File

@ -6,7 +6,7 @@ AI-powered job discovery and application pipeline. Automatically finds jobs, sco
1. **Search**: Scrapes Gradcracker, Indeed, LinkedIn, and UK Visa Sponsorship jobs. 1. **Search**: Scrapes Gradcracker, Indeed, LinkedIn, and UK Visa Sponsorship jobs.
2. **Score**: AI ranks jobs by suitability using OpenRouter. 2. **Score**: AI ranks jobs by suitability using OpenRouter.
3. **Tailor**: Generates a custom resume summary for top-tier matches. 3. **Tailor**: Generates a custom resume summary for top-tier matches.
4. **Export**: Automates [RxResume](https://v4.rxresu.me) to create tailored PDFs. 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). 5. **Manage**: Review and mark jobs as "Applied" via the dashboard (syncs to Notion).
## Example of generating a tailored resume for a job ## Example of generating a tailored resume for a job
@ -30,13 +30,12 @@ open http://localhost:3005
The app will guide you through setup on first launch. The onboarding wizard helps you: The app will guide you through setup on first launch. The onboarding wizard helps you:
- Connect your OpenRouter API key (for AI scoring/tailoring) - Connect your OpenRouter API key (for AI scoring/tailoring)
- Add your RxResume credentials (for PDF export) - Add your RxResume credentials (for PDF export via v4.rxresu.me)
- Upload your base resume JSON (exported from RxResume) - Select a template resume from your v4.rxresu.me account
## Structure ## Structure
- `/orchestrator`: React frontend + Node.js backend & pipeline. - `/orchestrator`: React frontend + Node.js backend & pipeline.
- `/extractors`: Specialized scrapers (Gradcracker, JobSpy, UKVisaJobs). - `/extractors`: Specialized scrapers (Gradcracker, JobSpy, UKVisaJobs).
- `/resume-generator`: Python script for RxResume PDF automation.
- `/data`: Persistent storage for SQLite DB and generated PDFs. - `/data`: Persistent storage for SQLite DB and generated PDFs.
Technical breakdowns here: `documentation/extractors/README.md` Technical breakdowns here: `documentation/extractors/README.md`
@ -69,19 +68,6 @@ npm run db:migrate
npm run dev npm run dev
``` ```
Set up the resume generator (used for PDF export):
```bash
cd ../resume-generator
python -m venv .venv
# Windows PowerShell:
.\.venv\Scripts\Activate.ps1
# macOS/Linux:
# source .venv/bin/activate
pip install playwright
python -m playwright install firefox
```
Dev URLs: Dev URLs:
- API: `http://localhost:3001/api` - API: `http://localhost:3001/api`
- UI (Vite): `http://localhost:5173` - UI (Vite): `http://localhost:5173`

View File

@ -38,7 +38,7 @@ Once a job is `ready`, the Ready panel is the "shipping lane":
The PDF is generated from: The PDF is generated from:
- The base resume JSON (uploaded via the Onboarding UI or Settings). - The base resume selected from your v4.rxresu.me account (via Onboarding or Settings).
- The job description (used for AI tailoring and project selection). - The job description (used for AI tailoring and project selection).
- Your tailored summary/headline/skills and selected projects. - Your tailored summary/headline/skills and selected projects.

View File

@ -14,7 +14,7 @@ No environment variables are strictly required to start. Simply run:
docker compose up -d --build docker compose up -d --build
``` ```
This builds a single container that runs the API, UI, scrapers, and resume generator. This builds a single container that runs the API, UI, and scrapers.
## 2) Access the app and Onboard ## 2) Access the app and Onboard
@ -24,8 +24,8 @@ Open your browser to:
On first launch, you will be greeted by an **Onboarding Wizard**. The app will help you validate and save your configuration: On first launch, you will be greeted by an **Onboarding Wizard**. The app will help you validate and save your configuration:
1. **Connect AI**: Add your OpenRouter API key (required for job scoring and summaries). 1. **Connect AI**: Add your OpenRouter API key (required for job scoring and summaries).
2. **PDF Export**: Add your RxResume credentials (if you want to generate tailored PDFs). 2. **PDF Export**: Add your RxResume credentials (used to export PDFs from v4.rxresu.me).
3. **Resume JSON**: Upload your base resume JSON (exported from RxResume). 3. **Template Resume**: Select a base resume from your v4.rxresu.me account.
The app saves these to its persistent database, so you don't need to manage `.env` files for basic setup. All other settings (like search terms, job sources, and more) can also be configured directly in the UI. The app saves these to its persistent database, so you don't need to manage `.env` files for basic setup. All other settings (like search terms, job sources, and more) can also be configured directly in the UI.
@ -34,7 +34,7 @@ The app saves these to its persistent database, so you don't need to manage `.en
`./data` is bind-mounted into the container. It stores: `./data` is bind-mounted into the container. It stores:
- SQLite DB: `data/jobs.db` (contains your API keys and configuration) - SQLite DB: `data/jobs.db` (contains your API keys and configuration)
- Generated PDFs: `data/pdfs/` - Generated PDFs: `data/pdfs/`
- Resume JSON: Stored internally after upload. - Template resume selection: Stored internally after selection.
## Updating ## Updating

View File

@ -31,10 +31,12 @@ orchestrator/
``` ```
2. **Set up environment:** 2. **Set up environment:**
```bash ```bash
cp .env.example .env cp .env.example .env
# The app is self-configuring. You can add keys via the UI Onboarding. # The app is self-configuring. You can add keys via the UI Onboarding.
``` ```
After the server starts, use the onboarding modal to connect OpenRouter, link your v4.rxresu.me account, and select a template resume.
3. **Initialize database:** 3. **Initialize database:**
```bash ```bash
@ -46,7 +48,7 @@ orchestrator/
npm run dev npm run dev
``` ```
This starts: This starts:
- Backend API at `http://localhost:3001` - Backend API at `http://localhost:3001`
- Frontend at `http://localhost:5173` - Frontend at `http://localhost:5173`
@ -119,5 +121,5 @@ npm start
- **Backend:** Express, TypeScript, Drizzle ORM, SQLite - **Backend:** Express, TypeScript, Drizzle ORM, SQLite
- **Frontend:** React, Vite, CSS (custom design system) - **Frontend:** React, Vite, CSS (custom design system)
- **AI:** OpenRouter API (GPT-4o-mini) - **AI:** OpenRouter API (GPT-4o-mini)
- **PDF Generation:** Wraps existing Python RXResume automation - **PDF Generation:** RxResume v4 API export (configured via Settings)
- **Job Crawling:** Wraps existing TypeScript Crawlee crawler - **Job Crawling:** Wraps existing TypeScript Crawlee crawler