cs-lewis-backend: Developer Onboarding Guide¶

Prerequisites¶

Install these before starting:

Verify everything:

# TODO: version-check commands

Quick Start (5 minutes)¶

# 1. Clone the repo
git clone git@github.com:Fueled/cs-lewis-backend.git
cd cs-lewis-backend

# 2. Bootstrap
# TODO: single command that sets up env, deps, db, hooks

# 3. Start the dev server
# TODO

# 4. Verify it works
# TODO: health-check curl → expected response

# 5. Open the API docs
# TODO

Environment Variables¶

Services¶

Project Architecture¶

Key Rules¶

1. [TODO]

Directory Map¶

Common Commands¶

# TODO: dev / db / test / lint / deps command groups

Adding a New Feature¶

CI/CD Pipeline¶

Git Workflow¶

• Branch from main
• Conventional commits: feat:, fix:, chore:, refactor:, docs:
• Open a PR against main; CI must pass before merge
• No Co-Authored-By or AI watermarks in commits

Common Gotchas¶

1. [TODO]

Key Documentation¶

Onboarding Checklist¶

• Complete Quick Start (app running, health check passing)
• Read API Overview
• Read AGENT_GUIDE.md at the project root
• Run the test suite and verify it passes
• Run the linter and verify it passes
• Pick up your first ticket and open a PR
• Ask your onboarding buddy if anything is unclear

Contacts¶

• Team Lead: [TODO]
• Slack: [TODO]
• Tracker: [TODO]