initial commit

Author: Sathvik-Rao

.env.example

@@ -0,0 +1,61 @@
+# ── StackResume — Configuration ───────────────────────────────────────────
+# Copy this file to .env. Everything here can ALSO be edited live from the
+# in-app Settings → API Keys / AI Models modal (the DB overlay takes
+# precedence over these defaults at runtime).
+
+# ── LLM provider ──────────────────────────────────────────────────────────────
+# One of: openai | anthropic | google | ollama | custom
+# Default is Google Gemini — set GOOGLE_API_KEY below.
+LLM_PROVIDER=google
+LLM_MODEL=gemini-2.5-flash
+LLM_TEMPERATURE=0.7
+
+# ── Provider API keys ─────────────────────────────────────────────────────────
+# Set the one matching LLM_PROVIDER. All can also be entered in the UI.
+OPENAI_API_KEY=
+ANTHROPIC_API_KEY=
+GOOGLE_API_KEY=
+
+# ── Custom OpenAI-compatible endpoint (optional) ─────────────────────────────
+# Only used when LLM_PROVIDER=custom. Point at any OpenAI-compatible API
+# (Azure OpenAI, vLLM, Together.ai, …). Auth still uses OPENAI_API_KEY.
+# OPENAI_BASE_URL=https://your-host/v1
+
+# ── Ollama (optional) ─────────────────────────────────────────────────────────
+# Only used if LLM_PROVIDER=ollama. Point at a host-installed Ollama server.
+# Inside Docker, use http://host.docker.internal:11434 to reach the host.
+OLLAMA_BASE_URL=http://host.docker.internal:11434
+
+# ── LangSmith tracing (optional) ──────────────────────────────────────────────
+# Set LANGSMITH_TRACING=true AND LANGSMITH_API_KEY to stream every LLM call
+# to LangSmith. Verify the connection from Settings → Test trace.
+LANGSMITH_API_KEY=
+LANGSMITH_PROJECT=stackresume
+LANGSMITH_TRACING=false
+
+# ── Quality settings ──────────────────────────────────────────────────────────
+MAX_REVIEW_ITERATIONS=3      # How many times to refine the resume (1-5)
+MIN_QUALITY_SCORE=82.0       # Stop refining when this score is reached (0-100)
+
+# ── Database ──────────────────────────────────────────────────────────────────
+# SQLAlchemy URL. The Docker compose file already sets this to the bind-mounted
+# /data path so you don't normally need to change it. For a local pip run:
+#   DATABASE_URL=sqlite+aiosqlite:///./stackresume.db
+# DATABASE_URL=sqlite+aiosqlite:////data/resume_builder.db
+
+# ── Optional admin auth (single user, session-based) ─────────────────────────
+# Off by default. Flip AUTH_ENABLED=true AND set AUTH_PASSWORD to require login.
+# Uses SHA-512 client-side hashing + 24h server-issued session tokens.
+# Login will return 503 if AUTH_ENABLED=true but AUTH_PASSWORD is empty.
+AUTH_ENABLED=false
+AUTH_USERNAME=admin
+AUTH_PASSWORD=
+
+# ── CORS ──────────────────────────────────────────────────────────────────────
+# Comma-separated list of allowed origins, or * to allow all (dev default).
+# Production example: CORS_ORIGINS=https://myapp.example.com
+# When AUTH_ENABLED=true and CORS_ORIGINS=* the server collapses to same-origin only.
+CORS_ORIGINS=*
+
+# ── App ───────────────────────────────────────────────────────────────────────
+DEBUG=false                  # Enables FastAPI debug + SQL echo when true

.github/pull_request_template.md

@@ -0,0 +1,31 @@
+## Summary
+
+<!-- What does this PR do? One or two sentences. -->
+
+## Type of change
+
+<!-- Choose one — this drives the version bump on merge. -->
+
+- [ ] `fix: ...` — bug fix → patch bump (0.0.**x**)
+- [ ] `feat: ...` — new feature → minor bump (0.**x**.0)
+- [ ] `feat!: ...` / `BREAKING CHANGE` — breaking change → major bump (**x**.0.0)
+- [ ] `chore:` / `docs:` / `ci:` / `refactor:` — no release created
+
+## PR title format
+
+Your PR title becomes the commit message on merge and determines the version bump:
+
+```
+feat(resume): add cover letter section
+fix: pdf export crash on empty work history
+feat!: replace /generate endpoint with /build (breaking)
+chore: update dev dependencies
+```
+
+Pattern: `type(optional-scope): short description in lowercase`
+
+## Checklist
+
+- [ ] Tests added / updated under `backend/tests/` for any changed `backend/app/` code
+- [ ] `pytest` passes locally (`cd backend && pytest`)
+- [ ] PR title follows the format above