# ngx-state

> An Angular module for managing app state without (much) overhead

Latest version **0.0.1** (published 2017-04-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install ngx-state
pnpm add ngx-state
yarn add ngx-state
bun add ngx-state
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2017-04-28 |
| First published | 2017-04-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Phillip Curl |
| Maintainers | philcurl |
| Keywords | angular2, angular |

## Links

- npm: https://www.npmjs.com/package/ngx-state
- Repository: https://github.com/phillipcurl/ngx-state
- Homepage: https://github.com/phillipcurl/ngx-state#readme
- Issues: https://github.com/phillipcurl/ngx-state/issues
- npm.io page: https://npm.io/package/ngx-state

## Recent versions

- 0.0.1 (latest) — 2017-04-28

## README

# ngx-state
[![Build Status](https://travis-ci.org/phillipcurl/ngx-state.svg?branch=master)](https://travis-ci.org/phillipcurl/ngx-state)
[![codecov](https://codecov.io/gh/phillipcurl/ngx-state/branch/master/graph/badge.svg)](https://codecov.io/gh/phillipcurl/ngx-state)
[![npm version](https://badge.fury.io/js/ngx-state.svg)](http://badge.fury.io/js/ngx-state)
[![devDependency Status](https://david-dm.org/phillipcurl/ngx-state/dev-status.svg)](https://david-dm.org/phillipcurl/ngx-state?type=dev)
[![GitHub issues](https://img.shields.io/github/issues/phillipcurl/ngx-state.svg)](https://github.com/phillipcurl/ngx-state/issues)
[![GitHub stars](https://img.shields.io/github/stars/phillipcurl/ngx-state.svg)](https://github.com/phillipcurl/ngx-state/stargazers)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/phillipcurl/ngx-state/master/LICENSE)

## Demo
https://phillipcurl.github.io/ngx-state/

## Table of contents

- [About](#about)
- [Installation](#installation)
- [Documentation](#documentation)
- [Development](#development)
- [License](#license)

## About

An Angular module for managing app state without (much) overhead

## Installation

Install through npm:
```
npm install --save ngx-state
```

Then include in your apps module:

```typescript
import { Component, NgModule } from '@angular/core';
import { NgxStateModule } from 'ngx-state';

@NgModule({
  imports: [
    NgxStateModule.forRoot()
  ]
})
export class MyModule {}
```

Finally use in one of your apps components:
```typescript
import { Component } from '@angular/core';

@Component({
  template: '<hello-world></hello-world>'
})
export class MyComponent {}
```

You may also find it useful to view the [demo source](https://github.com/phillipcurl/ngx-state/blob/master/demo/demo.component.ts).

### Usage without a module bundler
```
<script src="node_modules/ngx-state/bundles/ngx-state.umd.js"></script>
<script>
    // everything is exported ngxState namespace
</script>
```

## Documentation
All documentation is auto-generated from the source via [compodoc](https://compodoc.github.io/compodoc/) and can be viewed here:
https://phillipcurl.github.io/ngx-state/docs/

## Development

### Prepare your environment
* Install [Node.js](http://nodejs.org/) and [yarn](https://yarnpkg.com/en/docs/install)
* Install local dev dependencies: `yarn` while current directory is this repo

### Development server
Run `yarn start` to start a development server on port 8000 with auto reload + tests.

### Testing
Run `yarn test` to run tests once or `yarn run test:watch` to continually run tests.

### Release
* Bump the version in package.json (once the module hits 1.0 this will become automatic)
```bash
yarn run release
```

## License

MIT

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