> ## Documentation Index
> Fetch the complete documentation index at: https://ihub.learnille.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Developer Onboarding Guide

> Migrated from the previous Learnille internal documentation hub

## Welcome to the Learnille Engineering Team! 🎉

This guide provides a step-by-step roadmap to get your local environment configured and your first pull request submitted within your first week.

***

## 🗺 Onboarding Checklist

### Day 1: Access & Repository Setup

* [ ] Receive access to GitHub organization, Jira/Linear board, and Slack channels.
* [ ] Clone the repository: `git clone <repo-url> learnille`.
* [ ] Review the contribution and agent-instruction files in each repository you will work in.
* [ ] Read [the internal documentation overview](https://ihub.learnille.com/platform-overview.md).

### Day 2: Local Environment Setup

* [ ] Follow the setup steps in [`Dev-Setup-Guide.md`](../../engineering/development/dev-setup-guide.md).
* [ ] Install Node.js v18+, pnpm / npm, PostgreSQL, Redis, and Docker.
* [ ] Start backend server: `cd server && npm run start:dev`.
* [ ] Start admin dashboard: `cd admin && npm run dev`.
* [ ] Verify REST endpoints via Swagger at `http://localhost:3000/docs`.

### Day 3: First E2E Spec & Codebase Tour

* [ ] Review NestJS E2E playbook at [`Full-Application-E2E.md`](../../engineering/test-plan/full-application-e2-e.md).
* [ ] Run backend E2E tests: `cd server && npm run test:e2e`.
* [ ] Pick up your first "Good First Issue" from the backlog.

***

## 💡 Key Architectural Reminders

* **Independent Packages**: Treat `server`, `admin`, `instructor`, `student`, and `shared` as independent packages.
* **Strict Guarding**: Always protect new controller routes with `JwtAuthGuard` and `@CurrentUser()`.
* **Snake Case SQL**: Database column names use `snake_case` transformation.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.