This directory contains the frontend and backend-for-frontend modules for Omnibus.
| Module | Purpose |
|---|---|
| frontend-angular | Primary frontend |
| frontend-react | Alternative React frontend |
| dev-dashboard | Developer dashboard |
| bff-nest | NestJS backend-for-frontend |
Frontend apps
-> NestJS BFF
-> API gateway
-> micro services
The BFF shields UI clients from backend topology. In Docker Compose it calls the backend API gateway through the shared omnibus network.
docker compose up --build| Component | URL |
|---|---|
| Angular frontend container | http://localhost:4200 |
| NestJS BFF | http://localhost:3001 |
Use the README in the module you are working on. Common commands include:
cd bff-nest
npm install
npm run start:dev
cd ../frontend-angular
npm install
npm start
cd ../frontend-react
npm install
npm run start| Script | Purpose |
|---|---|
| bff-nest/run.sh | Run the NestJS BFF |
| frontend-angular/run.sh | Run the Angular frontend |
| frontend-angular/openapi.sh | Generate/update Angular OpenAPI client code |
| frontend-angular/orval.sh | Generate/update Orval client code |
| frontend-angular/nginx/entrypoint.sh | Frontend container entrypoint |
| frontend-react/run.sh | Run the React frontend |
- Add tRPC