Skip to content

docs(architecture): Record the shipped course domain #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ebouchut merged 1 commit into from
Jul 13, 2026
Merged

docs(architecture): Record the shipped course domain #94

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions ARCHITECTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ com.ericbouchut.learndev
├── auth # AuthController, RegistrationService, CustomUserDetailsService,
│ # PasswordResetController/Service/Mailer, entity/PasswordResetToken,
│ # dto/*Form, exception/Duplicate*Exception
├── course # entity/Course, Lesson, Enrollment (+EnrollmentId,
│ # EnrollmentStatus, PublicationStatus), repository/*,
│ # MarkdownRenderer (lesson Markdown to sanitized, cached HTML)
├── legal # LegalController (privacy policy page)
├── user # entity/User, repository/UserRepository
├── role # entity/Role, repository/RoleRepository
Expand Down Expand Up @@ -112,7 +115,7 @@ invalidates any others, and records the outcome in `audit_logs` through
## Data architecture

- **Relational core (PostgreSQL).** Users, roles, password-reset tokens, the
audit trail, and (upcoming) courses/lessons. Users use a **UUID** primary key
audit trail, courses, lessons, and enrollments. Users use a **UUID** primary key
to avoid enumeration; other tables use `BIGINT` identity
(see [ADR-0003](docs/adr/0003-uuid-pk-for-users-bigint-elsewhere.md)).
- **Document store (MongoDB).** Provisioned and configured for future content
Expand Down Expand Up @@ -158,8 +161,10 @@ as a static singleton container (see [ADR-0008](docs/adr/0008-share-singleton-te

## Direction of travel

- The course and lesson domain (course catalogue, enrollment, Markdown lesson
content).
- The course web layer on top of the shipped domain: student catalogue,
enrollment and lesson reading, instructor authoring and rosters, admin
account and content lifecycle (see
[docs/plans/2026-07-12-course-management-by-role.md](docs/plans/2026-07-12-course-management-by-role.md)).
- Possible extraction of microservices, with service-to-service authentication
([ADR-0002](docs/adr/0002-service-to-service-auth-via-service-token.md)).
- A `SUPERADMIN` role (deferred under YAGNI; issue #65).