Fleetat App Reference

This repository holds shared GitHub configuration and documentation for the Fleetat organization. It is the canonical reference for repository conventions, architecture decisions, and contribution guidelines that apply across all repos.

---

Repository Inventory

Repository	Purpose
fleetat-backend	Spring Boot + Spring Modulith back-end. Exposes REST APIs for vehicle and driver domain modules.
fleetat-fe-shell	Angular 21 shell application. Entry point and layout host for all microfrontends.
fleetat-mfe-discovery	Discovery API (Node.js/Express) and Nginx asset store for MFE registration and artifact serving.
fleetat-mfe-<name>	Individual microfrontend remotes. Each owns a single feature domain.

---

Architecture Decisions

Microfrontend approach: Native Federation (runtime, no build-time coupling). Each MFE remote is independently built, versioned, and deployed.

Back-end structure: Spring Modulith enforces explicit module boundaries. Inter-module communication goes through public API packages and application events — never direct internal calls.

Discovery: The fleetat-mfe-discovery server acts as the single source of truth for which MFE version is active. The Shell fetches the manifest at startup; MFEs register themselves after deployment via the /api/register endpoint.

---

Conventions

Versioning

All MFE artifacts are deployed under a versioned path (/<mfe-name>/v<semver>/). Version bumps are driven by package.json.

MFE Registration

After a successful build, MFEs register with the discovery server:

curl -X POST "$DISCOVERY_API/register" \
  -H "Authorization: Bearer $SECRET" \
  -H "Content-Type: application/json" \
  -d '{ "name": "<mfe-name>", "url": "<assets-host>/<mfe-name>/v<version>/remoteEntry.json" }'

Branch Strategy

• main — stable, production-ready.
• develop — integration branch for ongoing work.
• Feature branches: feature/<short-description>.

Commit Style

Follow Conventional Commits: feat:, fix:, chore:, docs:, etc.

---

Local Development

Refer to each repository's README.md for repo-specific setup. The typical full-stack startup order is:

1. fleetat-mfe-discovery — docker compose up --build
2. fleetat-backend — ./gradlew bootRun
3. fleetat-fe-shell — npm start
4. Individual MFE remotes — npm start (each on its own port)

---

Contributing

Open an issue or pull request in the relevant repository. For cross-cutting concerns (conventions, architecture), open a discussion or PR here.