|
|
@@ -0,0 +1,45 @@
|
|
|
+# Copilot Instructions for FISApp UI
|
|
|
+
|
|
|
+## Project Overview
|
|
|
+- This is a modular Angular application for the Financial Information System (FISApp UI).
|
|
|
+- Major dependencies are managed in `src/dependencies/`:
|
|
|
+ - `angularlib`: SWOPT's shared Angular components
|
|
|
+ - `dp-ui`: Domain Proxy UI library
|
|
|
+ - `fis`: FIS library for TypeScript
|
|
|
+- The main app code is in `src/app/` with feature modules under subfolders (e.g., `dashboard/`, `menu/`).
|
|
|
+
|
|
|
+## Developer Workflows
|
|
|
+- **Initialize**: Run `./init-project` (or `init-project.ps1` on Windows) after cloning to install dependencies.
|
|
|
+- **Clean**: Use `./clean-project` (or `clean-project.ps1`) if you encounter dependency issues, especially with Angular libraries.
|
|
|
+- **Development server**: Use `ng serve` to start the app at `http://localhost:4200/`.
|
|
|
+- **Build**: Use `ng build` to generate production assets in `dist/`.
|
|
|
+- **Unit tests**: Run `ng test` (Karma).
|
|
|
+- **E2E tests**: Run `ng e2e` (add a platform if not present).
|
|
|
+
|
|
|
+## Key Conventions & Patterns
|
|
|
+- Shared Angular modules and components are in `src/dependencies/angularlib/`.
|
|
|
+- Domain-specific UI logic is in `src/dependencies/dp-ui/`.
|
|
|
+- Project-specific configuration is in `src/config/` and `src/assets/`.
|
|
|
+- Use Angular CLI for scaffolding (`ng generate ...`).
|
|
|
+- If you see TS-993004 errors about `CommonModule`, clean the `angularlib/node_modules/@angular` folder as described in the main README.
|
|
|
+
|
|
|
+## Integration & Data Flow
|
|
|
+- The app is structured for modularity: each feature (dashboard, menu, etc.) is a subfolder in `src/app/`.
|
|
|
+- Cross-cutting services and base classes are in the shared libraries under `src/dependencies/`.
|
|
|
+- External dependencies are managed via `package.json` and the `init-project` script.
|
|
|
+
|
|
|
+## Examples
|
|
|
+- To add a new component: `ng generate component my-feature`
|
|
|
+- To clean Angular dependencies (Windows):
|
|
|
+ ```powershell
|
|
|
+ rm -r -force src/dependencies/angularlib/node_modules/@angular
|
|
|
+ ./clean-project.ps1
|
|
|
+ ```
|
|
|
+
|
|
|
+## References
|
|
|
+- Main app: `src/app/`
|
|
|
+- Shared libraries: `src/dependencies/angularlib/`, `src/dependencies/dp-ui/`, `src/dependencies/fis/`
|
|
|
+- Configuration: `src/config/`, `src/assets/`
|
|
|
+- Build/test scripts: root directory and `build/`
|
|
|
+
|
|
|
+For more, see the main `README.md` and library-specific `README.md` files in `src/dependencies/`.
|
