Quickstart ​

Get Suitcase running on your machine in under 2 minutes.

Prerequisites ​

  • Python 3.10+ and pip
  • Node.js 18+ (for building the frontend)
  • An LLM endpoint — see LLM Providers for options

1. Clone & Install ​

bash
git clone https://github.com/achuthanmukundan00/Suitcase.git
cd AutoCareer/job-copilot

# Python virtual environment
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

# Build the frontend (React + TypeScript)
cd frontend
npm install
npm run build
cd ..

2. Start the Server ​

bash
.venv/bin/python -m uvicorn app.main:app --host 0.0.0.0 --port 8000

Open http://localhost:8000 in your browser.

3. Complete Setup ​

The setup wizard guides you through:

  1. Profile — name, target role, career direction
  2. GitHub (optional) — connect your repos for evidence scanning
  3. LinkedIn & Discord (optional) — data sources and chat channels
  4. Resume — upload a PDF, text, or markdown resume
  5. GitHub sync (optional) — pull repo signals and evidence
  6. LLM endpoint — configure your model and API key
  7. Finish — review and enter the admin console

4. Meet Suitcase ​

Once setup is complete, the navbar shows a "Suitcase wants to chat" button. Click it to start your first conversation. Suitcase will introduce itself, mention what it learned during setup, and ask where you'd like to start.

Optional: Discord ​

Enable the Discord bot to chat with Suitcase through DMs:

bash
# Add to your .env
DISCORD_BOT_TOKEN=your-bot-token
DISCORD_TARGET_USER_ID=your-user-id
DISCORD_ENABLED=true

Create a Discord bot → invite it to your server → add the token and your user ID to .env.

Optional: GitHub Intelligence ​

Connect GitHub so Suitcase can scan your repos for career evidence:

bash
# Add to your .env (or configure in the UI)
GITHUB_TOKEN=github_pat_...

Without a token, GitHub sync is limited to ~60 API requests/hour.

Next Steps ​

  • Full Setup Guide — detailed walkthrough for each provider
  • LLM Providers — configure Relay with llama.cpp, OpenAI, Anthropic, DeepSeek, LM Studio, and more
  • Architecture — how Suitcase works under the hood

Your private career copilot.