Developer guide
This section is for contributors, integrators, and AI agents working with the BraDypUS codebase.
Quick orientation
| You want to… | Read… |
|---|---|
| Understand how the app bootstraps | Architecture |
| Find which file handles X | lib/ map · Modules |
| Understand the DB layer | Database |
| Write a new migration | DB migrations |
| Understand the query DSL | SQL layer |
| Understand record read / write | Record lifecycle |
| Understand config schema & access control | Config & UAC |
| Work on the Vue frontend | Frontend |
| Add OAuth support | OAuth2 / SSO |
| Set up transactional email (password reset, self-registration) | Email (Resend) |
| Use the widget API | Widget API |
| Connect Zotero bibliography | Zotero integration |
| Run the test suite | Testing |
| Find environment variables / data directory layout | Architecture |
Source repositories
| Repo | Contents |
|---|---|
| lad-sapienza/BraDypUS | Monorepo: PHP API (bdus-api/), Vue 3 frontend (bdus-app/), and this documentation site (bdus-docs/) |