Skip to content

README.md

Latest commit

 

History

History
69 lines (50 loc) · 2.09 KB

README.md

File metadata and controls

69 lines (50 loc) · 2.09 KB
Raw

ApplyWorkflow Logo

MIT License Made with Python NPM Version Open Source Love

ApplyWorkflow

Open-source pipeline to automate job applications: tailor CVs and emails with an LLM, compile PDFs with Typst, and optionally send via Gmail from CLI or web UI.

Features

  • LLM-tailored CV keywords and emails (Groq or OpenAI)
  • Typst CV → PDF per application
  • Optional Gmail sending (safe dry-run by default)
  • FastAPI backend + React web UI
  • Docker image includes Typst for zero local setup

Quick start

docker-compose up --build

Then open http://localhost:8000 and use Settings to add your API key, profile, and optional Google OAuth credentials. API documentation is available at http://localhost:8000/docs.

Docker persists all user files under ./data/.

Usage

CLI:

  • Dry run: python main.py
  • Compile PDFs: python main.py --compile-pdf
  • Send emails: python main.py --send --compile-pdf

Web UI:

Config & required files

Docker configuration is managed from the web UI and stored in data/settings.json. The app creates data/applications.xlsx automatically. Profile, OAuth credentials, tokens, and generated output also stay in data/; this directory is git-ignored.

For local CLI use, copy .env.example to .env and profile.json.example to profile.json. Gmail credentials remain optional.

Contributing

Contributions welcome! See CONTRIBUTING.md. Please open issues and PRs.

License

MIT — see LICENSE.