Skip to content

README.md

Latest commit

 

History

History
56 lines (45 loc) · 5.25 KB

README.md

File metadata and controls

56 lines (45 loc) · 5.25 KB
Raw

Angularity

Opinionated Angular toolkit facilitating scalable application development

Angularity is a collection of packages that provide high-level abstractions and utilities around Angular and the Angular ecosystem.

Package Description Links
core Foundation artifacts and utilities shared across Angularity packages docs , source
cdk Component development primitives based on @angular/cdk docs , source
forms Convenience abstractions for implementing custom Angular form control components docs , source
router Convenience utilities for the Angular routing system docs , source
icons Lightweight and flexible solution for managing and displaying SVG icons docs , source
elements High-level abstractions for working with Angular Elements docs , source
theming Programmatic runtime theming system based on CSS variables docs , source
theming-material Material Design theme builders based on the theming package docs , source
command-flow Centralized command/event system for reactively modeling application business docs , source
endpoints Declarative and type-safe access to HTTP API endpoints docs , source
config-files Declaratively and type-safe access to remote config files docs , source
fire Firebase and RxFire abstractions docs , source

The following command installs all the Angularity packages. Pick and choose the packages you need for your project:

npm i \
  @angularity/core \
  @angularity/cdk \
  @angularity/forms \
  @angularity/router \
  @angularity/icons \
  @angularity/elements \
  @angularity/theming \
  @angularity/theming-material \
  @angularity/command-flow \
  @angularity/endpoints \
  @angularity/config-files \
  @angularity/fire

To update all Angularity packages, run:

npx update-by-scope @angularity

Documentation

Documentation is hierarchical, and every fact lives at its nearest source:

  • This root README.md is a router: it lists every package and points to more; it holds no detail that belongs to a package.
  • Each package's README.md is the single source of truth for its consumer docs — what npmjs.com and GitHub render.
  • Each package's CLAUDE.md documents the package for maintainers, and @-includes its README.md.
  • Per-symbol API descriptions live in the exported symbol's JSDoc.
  • The documentation site under /docs is generated: npm run docs:generate projects each package README.md (with JSDoc injected) into its ng-doc page. Never edit a generated docs/src/content/packages/*/index.md by hand.

Authoring conventions live in .claude/rules/documentation-authoring.md.