Skip to content

3AM Docs

Welcome to the engineering docs for 3AM.

The repository name is 3am-frontend, but the project name is 3AM. This documentation is written for contributors who need to understand the code quickly, make safe changes, and open clean pull requests.

Why this documentation exists

These docs are not a wiki dump. The goal is practical: when you open a page, you should understand what to edit, why it is done that way in this project, and how to validate your change before PR.

How to read this documentation

If you want a full understanding path, read in this exact order:

  1. Getting Started
  2. Guidelines
  3. View Lifecycle
  4. Templates
  5. Pages and Routing
  6. Sections
  7. Styles
  8. Ready Components
  9. Building Components
  10. Core System
  11. Lazy Media System
  12. Navbar
  13. Hero Carousel
  14. Performance
  15. Testing
  16. Contributing