@cccteam/ccc-lib
v0.0.24
Published
**ccc-lib** is a comprehensive Angular library developed by the [cccteam](https://cloudcomputingconsultants.com/). It is designed to provide a consistent and configurable foundation for building enterprise-level data-driven applications. By defining a con
Readme
ccc-lib
ccc-lib is a comprehensive Angular library developed by the cccteam. It is designed to provide a consistent and configurable foundation for building enterprise-level data-driven applications. By defining a configuration, you can dynamically generate entire application pages.
Core Features
- Dynamic Page Generation: Define a
resourceConfigto dynamically render components and build complex layouts. For example, theresource-resolvercan switch between components based on your data. - Authentication & Authorization: A set of services and guards for managing user authentication and permissions.
- Rich UI Components: A collection of UI components, including a grid wrapper for Kendo UI, alert services, and more.
- Utility Functions: A set of helper functions for various tasks, such as data manipulation and request customization. Also included are tools for handling PATCH requests per the JSON Patch standard RFC 6902.
Getting Started
To install ccc-lib in your project, run the following command:
npm install ccc-libCore Concepts
The central concept of ccc-lib is the resourceConfig. This configuration object defines the structure and behavior of a page or a part of a page. It specifies which components to render, how they are connected, and how they interact with data.
The compound-component component is the engine that brings the resourceConfig to life. It dynamically creates and configures components based on the provided configuration, allowing for highly flexible and data-driven UIs.
Modules Overview
ccc-resource: The core module of the library. It contains the components and services related to dynamic page generation and data management.auth: This module provides authentication and authorization, including login forms, route guards, and permission directives.ui: This module contains UI components and services, such as alerts, notifications, and sidenav components. It also includes theccc-gridcomponent, a wrapper for the Kendo UI grid that allows for dynamic configuration.utils: A collection of utility pipes and functions for various purposes.
Development
Building the Library
To build the library locally, use the Angular CLI:
ng build ccc-libRunning Tests
To run the library's tests, use the following command:
ng test ccc-libKnown Issues
- Contentful Dependency: The library currently has a hard dependency on
@contentful/rich-text-typesdue to theCustomTypes.ContentfulDocumenttype definition in the resource metadata. This means consumers of the library must have this package installed, even if they are not using this custom type.
