This repository contains schematics for generating NGXS Store in Angular apps using the Angular CLI.
## Installation
### Install Angular CLI
You should be using `@angular/cli@6.1.0` or newer.
```bash
npm i -g @angular/cli
```
### Install NGXS Schematics
```bash
npm i -g @ngxs/schematics
```
## Usage
### Creating a new project
To generate new Angular project with NGXS Store, you can use `ng new` with `@ngxs/schematics` specified as the schematics collection.
```bash
ng new --collection=@ngxs/schematics my-app
```
### Create a NGXS Store
To generate store with `@ngxs/schematics`:
```bash
ng generate @ngxs/schematics:store --name todo
```
Result:
```ts
CREATE src/todo/todo.actions.ts
CREATE src/todo/todo.state.ts
```
Or with spec:
```bash
ng generate @ngxs/schematics:store --name todo --spec
```
Result:
```ts
CREATE src/todo/todo.actions.ts
CREATE src/todo/todo.state.spec.ts
CREATE src/todo/todo.state.ts
```
### Create a NGXS State
To generate state with `@ngxs/schematics`:
```bash
ng generate @ngxs/schematics:state --name todo
```
Result:
```ts
CREATE src/todo/todo.state.ts
```
Or with spec:
```bash
ng generate @ngxs/schematics:state --name todo --spec
```
Result:
```ts
CREATE src/todo/todo.state.spec.ts
CREATE src/todo/todo.state.ts
```
### Create a NGXS Actions
To generate state with `@ngxs/schematics`:
```bash
ng generate @ngxs/schematics:actions --name todo
```
Result:
```ts
CREATE src/todo/todo.actions.ts
```
## NGXS Starter Kit
### Usage
To generate store with `@ngxs/schematics:starter-kit`:
```bash
ng generate @ngxs/schematics:starter-kit
```
Result:
```ts
CREATE src/store/store.config.ts
CREATE src/store/store.module.ts
CREATE src/store/auth/auth.actions.ts
CREATE src/store/auth/auth.state.ts
CREATE src/store/auth/model/auth.model.ts
CREATE src/store/dashboard/index.ts
CREATE src/store/dashboard/states/dictionary/dictionary.actions.ts
CREATE src/store/dashboard/states/dictionary/dictionary.state.ts
CREATE src/store/dashboard/states/dictionary/model/dictionary-response.model.ts
CREATE src/store/dashboard/states/user/user.actions.ts
CREATE src/store/dashboard/states/user/user.state.ts
CREATE src/store/dashboard/states/user/model/person.model.ts
```
Or with spec:
```bash
ng generate @ngxs/schematics:starter-kit --spec
```
Result:
```ts
CREATE src/store/store.config.ts
CREATE src/store/store.module.ts
CREATE src/store/auth/auth.actions.ts
CREATE src/store/auth/auth.state.spec.ts
CREATE src/store/auth/auth.state.ts
CREATE src/store/auth/model/auth.model.ts
CREATE src/store/dashboard/index.ts
CREATE src/store/dashboard/states/dictionary/dictionary.actions.ts
CREATE src/store/dashboard/states/dictionary/dictionary.state.spec.ts
CREATE src/store/dashboard/states/dictionary/dictionary.state.ts
CREATE src/store/dashboard/states/dictionary/model/dictionary-response.model.ts
CREATE src/store/dashboard/states/user/user.actions.ts
CREATE src/store/dashboard/states/user/user.state.spec.ts
CREATE src/store/dashboard/states/user/user.state.ts
CREATE src/store/dashboard/states/user/model/person.model.ts
```
---
_Source: https://npm.io/package/ngxs-schematics · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
