Skip to main content

Run Locally

🖥️ Run the Job Search Assistant Locally​

If you prefer to run the app on your own machine (for privacy, customization, or speed), here’s how to do it.

This lets you tweak, inspect, or extend the app’s logic while running it through a friendly Streamlit interface.

🔧 Prerequisites​

  • Python 3.10 or higher
  • Git (to clone the repository)
  • A virtual environment (optional but recommended)

🚀 Setup Steps​

1. Clone the Repository​

git clone https://github.com/terra-foundation/job-explorer.git
cd job-explorer

2. Install Dependencies​

We recommend using a virtual environment:

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Alternatively, if you're using Poetry:

poetry install
poetry shell

3. Run the App​

streamlit run jobserp_explorer/app.py

Streamlit will launch your browser and open the app interface at:

http://localhost:8501

📂 Folder Structure​

Here’s what matters when running locally:

  • jobserp_explorer/app.py — this is the entry point
  • views/ — defines each tab of the UI
  • core/ — contains the processing pipeline
  • data/ — outputs from your job searches will be saved here

✅ What You Can Do​

  • Run and monitor job search sessions
  • View and edit prompts
  • Review structured results
  • Export customized job sets
  • Start hacking on the logic

For full developer setup, including CLI tools and contributions, see Dev Setup.