Getting Started with AquaGen
Welcome! AquaGen is our enterprise water-management web application, built as an Nx monorepo with React, Material-UI, React Router, and TypeScript. This section gets you from zero to productive.
New here? Read the Platform Overview first (10 minutes) — it explains what AquaGen does, the stack, and how the code is organized. Then pick your path below.
Choose your path
Onboarding has two phases. Phase 1 is optional — take it only if you need the React fundamentals. Phase 2 is the same for everyone.
🟢 New to React (interns & early-career) → start with Phase 1
If you haven't built a React app end-to-end, begin with Frontend Foundations.
You'll build one small practice app that calls dummy APIs and is structured just like one
of our feature libraries (dataSource / controller / store / components) — so you learn the
fundamentals and our architecture in miniature, plus Git & GitHub. No prior React needed. Then
you continue to Phase 2 like everyone else.
🔵 Already know React (experienced devs) → skip to Phase 2
If you're comfortable with components, hooks, routing, and data fetching, skip Foundations. Go straight to Installation & Setup, then the Practice track — the guided, hands-on path that lives in the Architecture section.
The recommended order
| Phase | Step | Page | For |
|---|---|---|---|
| — | 1 | Platform Overview | Everyone — what AquaGen is |
| 1 | 2 | Frontend Foundations | New to React (skip if experienced) |
| 2 | 3 | Installation & Setup | Everyone — run the app locally |
| 2 | 4 | Architecture → Practice | Everyone — learn our architecture by changing it locally |
Phase 2 is common to all recruits — interns who finished Foundations and experienced developers land in the same place: the Practice track (in the Architecture section), where you set the app up, make your first local commit, and make a few changes on a local branch to learn how it's built.
Handy references
- Commands Reference — every npm/Nx script (start, build, create/integrate libs, deploy) explained.
- Architecture Diagrams — a visual map of the whole system.
If you're blocked for more than ~30 minutes, ask your onboarding buddy or the team channel. Getting unblocked fast is a skill, not a weakness.