🚀 Developer Setup
Get the repo running with CLI or UI in minutes.
This guide reflects how the app is actually built and used — no fluff, no out-of-date boilerplate.
🔧 Quickstart
git clone https://github.com/yourname/jobserp_explorer
cd jobserp_explorer
python -m venv venv
source venv/bin/activate
pip install -e .
▶️ Launch the Streamlit App
streamlit run jobserp_explorer/app.py
This opens the visual UI with tabs for:
- 🔍 Querying
- ⚙️ Config editing
- 📋 Results inspection
- 🧠 Prompt tweaking
▶️ Run from CLI
You can use either:
jobserp-explorer --query "data science"
Or invoke the pipeline scripts manually:
python jobserp_explorer/core/10_run_full_pipeline.py --query "data science"
💡 Developer Notes
-
.env
file is optional. Needed if you use private LLM keys or environment variables. -
core/
scripts are standalone, but expect directory layout managed byrun_manager.py
. -
Output folders land in:
data/01_fetch_serps/run_<timestamp>/
Use these to debug, aggregate results, or inspect individual stages.
📌 Summary
Page | Purpose |
---|---|
good-first-issues.md | Entry-level contributions to improve UX |
architecture-overview.md | Understand code structure and flow |
dev-setup.md | Reproduce your full cycle with UI, CLI, and editable install |
🧩 Tip
If contributing to flows, look in:
jobserp_explorer/flow_jobposting/
jobserp_explorer/flow_pagecateg/
These use PromptFlow
-style structures (.jinja2
, .json
, .yaml
) and can be customized easily.
You're now fully set up to contribute, test, or fork your own version of the app.