# ngx-cms-common-app

> This library was built to develop and distribute common angular 2+ components. It also contains an example angular application that can be used to test existing and new components.

Latest version **1.2.1** (published 2019-02-07) · 0 weekly downloads

## Install

```sh
npm install ngx-cms-common-app
pnpm add ngx-cms-common-app
yarn add ngx-cms-common-app
bun add ngx-cms-common-app
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2019-02-07 |
| First published | 2019-02-07 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 19 |
| Unpacked size | 186 KB |
| Known vulnerabilities | 0 (+23 in 5 direct dependencies) |
| Install scripts | no |
| Maintainers | cmsgov |

## Links

- npm: https://www.npmjs.com/package/ngx-cms-common-app
- npm.io page: https://npm.io/package/ngx-cms-common-app

## Dependencies (19)

- [rxjs](https://npm.io/package/rxjs.md) ~6.3.3
- [core-js](https://npm.io/package/core-js.md) ^2.5.4
- [zone.js](https://npm.io/package/zone.js.md) ~0.8.26
- [date-fns](https://npm.io/package/date-fns.md) ^1.30.1
- [highlight.js](https://npm.io/package/highlight.js.md) ^9.13.1
- [@angular/core](https://npm.io/package/@angular/core.md) ^7.1.1
- [@angular/http](https://npm.io/package/@angular/http.md) ^7.1.1
- [ngx-clipboard](https://npm.io/package/ngx-clipboard.md) ^11.1.9
- [@angular/forms](https://npm.io/package/@angular/forms.md) ^7.1.1
- [@angular/common](https://npm.io/package/@angular/common.md) ^7.1.1
- [@angular/router](https://npm.io/package/@angular/router.md) ^7.1.1
- [ngx-highlightjs](https://npm.io/package/ngx-highlightjs.md) ^3.0.1
- [ngx-page-scroll](https://npm.io/package/ngx-page-scroll.md) ^5.0.1
- [@angular/compiler](https://npm.io/package/@angular/compiler.md) ^7.1.1
- [@angular/animations](https://npm.io/package/@angular/animations.md) ^7.1.1
- [@angular/platform-browser](https://npm.io/package/@angular/platform-browser.md) ^7.1.1
- [@thisissoon/angular-scrollspy](https://npm.io/package/@thisissoon/angular-scrollspy.md) ^2.1.0
- [@thisissoon/angular-inviewport](https://npm.io/package/@thisissoon/angular-inviewport.md) ^4.1.0
- [@angular/platform-browser-dynamic](https://npm.io/package/@angular/platform-browser-dynamic.md) ^7.1.1

## Recent versions

- 1.2.1 (latest) — 2019-02-07
- 5.0.0-beta.0 (beta) — 2024-04-16
- 4.1.1-beta.0 — 2024-04-08

## README

# ngx-cms-common

This library was built to develop and distribute common angular 2+ components. It also contains an example angular application that can be used to test existing and new components.

## Structure

The repository follows the best practices defined by angular-cli. The root directory was generated using `ng new ngx-cms-common-app` to scaffold out a basic angular application. Within the application directory, `ng g library ngx-cms-common` was executed to generated the projects folder and supporting library configuration. All component development occurs in the `project` directory. Anything outside of `project` is strictly for the example application.

## Installation

The library can be installed via npm with `ngx-cms-common`.

## Run Local Wiki
`npm start` will start up a local wiki served at `http://localhost:5555`

## Usage

`cms` is the library prefix. This means that all component and directive names are by default generated with `cms` at the beginning. Using the `Dropdown` module as an example, `cms-dropdown` is the component selector and `cmsDropdown` is the the directive selector.

## Release Workflow

1. Checkout a feature branch from develop and make your changes

2. Open a PR to merge your feature branch into develop.

2. Once develop has enough changes to warrant a release, a release branch should be created by branching off of develop. (_NOTE: Coordinate with the rest of the team to create an appropriate branch_).

3. Once a release branch becomes available, a beta version should be published to npm so that consumers can test the potential release. [How to publish a beta version](#how-to-publish-a-beta-version)

5. For fixes/changes that need to be made to a potential release, you should branch off of the release branch and open a PR to merge back into it. Anytime changes are made to a release branch, a new beta version should be published. [How to publish a beta version](#how-to-publish-a-beta-version)

7. Once a beta release is ready to become a full version, open a PR to merge release into master.

8. Once the release has been merged into master, you can publish a new version: [How to publish a version](#how-to-publish-a-version)

### How to publish a beta version

1. In the release branch update `projects/ngx-cms-common/package.json` version with the appropriate beta version. All beta versions should have `-beta.X` appended to them. For example, for `release/3.2.0` branch, the version should read `3.2.0-beta.0`.
2. Once the version is update you can publish the beta version using:

    1. `cd /dist/ngx-cms-common`
    2. `npm publish --tag beta`

3. For subsequent beta releases, the final number in the version should be incremented. For example, the next beta version after `3.2.0-beta.0` would be `3.2.0-beta.1`.

### How to publish a version

1. In the master branch update `projects/ngx-cms-common/package.json` version with the appropriate version. For example `3.2.0-beta.0` would be updated to `3.2.0`.
2. Once the version is update you can publish version using:

    1. `cd /dist/ngx-cms-common`
    2. `npm publish`

---
_Source: https://npm.io/package/ngx-cms-common-app · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._