NgxIconifyStack Workspace 🏗️

August 14, 2026 · View on GitHub

Welcome to the monorepo workspace for ngx-iconify-stack. This repository contains the core library, its schematics, and the official documentation site.

📁 Project Structure

  • projects/ngx-iconify-stack/ - The core Angular library source code.
  • projects/ngx-iconify-stack/src/schematics/ - Angular CLI schematics to automate library setup (ng add, generate-icon-subset, skill).
  • projects/docs/ - Official documentation site — Angular 22 SSR app with the library in action. Landing page (/) plus a /docs route with the full library documentation (provider config, component inputs, rendering modes, schematics, and catalog tools).

🚀 Quick Start for Contributors

To set up the workspace locally, follow these steps:

1. Install Dependencies

This project uses npm as its package manager:

npm install

2. Quick Development Commands

Run these commands from the root directory:

TaskCommandDescription
Start Docsng serve docsLaunches the local dev server for the documentation site.
Build Librarynpm run build:libCompiles the library and its schematics into the dist/ directory.
Run Testsng test ngx-iconify-stackRuns the library unit tests (Vitest).
Icon Subsetnpm run ngx-iconify-stack:generate-iconsScans templates and rebuilds the offline icon subset.

Gotcha — building the library: a bare ng build ngx-iconify-stack (ng-packagr) wipes dist/ and emits only library bundles — no schematics. The schematics (ng-add, generate-icon-subset, add-icon, skill) land in dist/ only via npm run build:lib, which runs tsc to dist/ plus a copyfiles postbuild. Always use npm run build:lib (or the library's own npm run build) when you need the schematics in dist/, e.g. before installing the library into a scratch app for E2E.

🤝 Contribution Guidelines

We use conventional commits and structured branching to keep the history clean.

Commit Messages

Please follow the Conventional Commits specification (e.g., feat(lib): add color input or fix(schematics): resolve config paths).

Development Workflow

  1. Fork the repository and create your feature branch (git checkout -b feature/my-new-feature).
  2. Implement your changes. Make sure to run ng test ngx-iconify-stack and npm run build:lib to verify that everything builds and passes.
  3. Commit your changes using conventional commits, push to your fork, and open a Pull Request.

For technical details on how to use the library in your own project, please refer to the Library README.