Skip to main content

1. Setup & Monorepo Structure

Goal for this page: have the real app running locally and understand how the repository is organized before you touch any feature.

Step 1.1 — Get access & clone the repo​

What & why: The frontend lives in the Fluxgentech/aquagen_web_appp repository. You need access before anything else.

Do this:

Your task: Get repo access and clone it locally.

Step 1.2 — Install & run locally​

What & why: Getting the dev server running proves your environment is set up and gives you a live app to explore alongside the docs.

Do this:

Your task: Install dependencies, start the dev server, and open the running app in your browser. Confirm you can log in / reach the main dashboard.

Step 1.3 — Create your branch & initial commit​

What & why: You'll explore this codebase by changing it, so start on your own branch — never directly on main. An initial commit gives you a clean checkpoint to diff against as you experiment over the next pages.

Do this:

  • Create a personal working branch off main, e.g. onboarding/<your-name>.
  • Make a tiny, harmless change (a comment or a console.log), then commit it locally.
  • Reference: GitHub: About branches.
git checkout -b onboarding/your-name
# ...make a small change...
git add -A
git commit -m "chore: onboarding checkpoint"

Your task: Create your branch, make your initial commit, and confirm git status is clean. Keep all further exploration on this branch — do not push to main.

Step 1.4 — Understand the monorepo layout​

What & why: This is an Nx monorepo. Application shells live in apps/, and almost all real code lives in feature libraries under libs/ (e.g. libs/shared, libs/components, and one library per feature). Knowing this map is the difference between "lost" and "productive."

Learn:

Your task: In the cloned repo, open the top-level folders and write yourself a one-line note on what apps/ vs libs/ contain. List the library folders under libs/ and guess what each is responsible for from its name. You'll confirm these guesses over the next pages.

Checkpoint

The app runs locally and you have a mental map of apps/ vs libs/. Next, the stack it's built on and the fact that it's actually several apps.

Next: → Tech stack & the apps