jobspeed/README.md

JobSpeed - Job Application Auto-fill Extension

A Firefox browser extension that helps you auto-fill job applications using your resume data.

Features

• 📄 Resume Storage: Upload and store your resume securely in the extension
• 🔍 Smart Form Detection: Automatically detect form fields on job application pages
• 👀 Preview Mode: See what content will be filled before applying changes
• ⚡ One-Click Auto-fill: Apply your resume data to forms with a single click
• 🎯 Intelligent Matching: Smart field matching based on labels and field names

Tech Stack

• TypeScript (Strict mode)
• Vite - Fast build tool
• Vitest - Unit testing
• ESLint + Prettier - Code quality and formatting
• Native Browser API - Firefox WebExtensions API

Getting Started

Prerequisites

• Node.js 20+
• pnpm (recommended) or npm

Installation

1. Install dependencies:

pnpm install

2. Start development mode:

pnpm dev

3. Load the extension in Firefox:
   • Open Firefox
   • Navigate to about:debugging#/runtime/this-firefox
   • Click "Load Temporary Add-on"
   • Select the manifest.json file from the dist folder

Build for Production

pnpm build

The production-ready extension will be in the dist folder.

Development

Available Scripts

• pnpm dev - Build and watch for changes
• pnpm build - Production build
• pnpm test - Run tests
• pnpm test:ui - Run tests with UI
• pnpm lint - Lint code
• pnpm lint:fix - Fix linting issues
• pnpm format - Format code with Prettier
• pnpm format:check - Check code formatting

Project Structure

src/
├── manifest.json           # Extension manifest
├── background.ts           # Background service worker
├── content.ts              # Content script for page interaction
├── popup.ts                # Popup UI logic
├── popup.html              # Popup HTML
├── popup.css               # Popup styles
├── types/
│   ├── index.ts            # Type definitions
│   └── browser.d.ts        # Browser API types
└── services/
    ├── formDetector.ts     # Form field detection logic
    └── fieldMatcher.ts     # Resume-to-field matching logic

job-application-demo/       # Sample job application form (separate app)

Demo Application

The job-application-demo folder contains a standalone sample job application form built with Vite, React, Material UI, and TypeScript. This demo app:

• Showcases the structure and fields used by the JobSpeed extension
• Uses the same ResumeData interface as the extension
• Saves submitted applications as incremental JSON files
• Is excluded from the main extension build
• Has its own package.json and can be run independently

To run the demo:

cd job-application-demo
pnpm install
pnpm dev

See job-application-demo/README.md for more details.

Usage

1. Upload Your Resume:

   • Click the JobSpeed extension icon
   • Click "Upload Resume"
   • Select your resume file (PDF, TXT, DOC, DOCX)

2. Auto-fill a Job Application:

   • Navigate to a job application page
   • Click the JobSpeed extension icon
   • Click "Scan Current Page"
   • Review the suggested values in the preview panel
   • Click "Apply Auto-fill" to fill the form

Features in Detail

Resume Parsing

The extension extracts key information from your resume:

• Personal information (name, email, phone, address)
• Work experience
• Education
• Skills
• Professional summary

Smart Field Matching

The field matcher uses intelligent algorithms to match resume data with form fields:

• Label-based matching
• Name/ID attribute matching
• Placeholder text matching
• Contextual matching (e.g., "current company", "most recent position")

Privacy & Security

• All data is stored locally in your browser
• No data is sent to external servers
• You have full control over your resume data

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

ISC

Author

Your name here