https://github.com/ngrx/example-app

Example app showcasing the ngrx platform
https://github.com/ngrx/example-app

angular ngrx observables redux rxjs

Last synced: 3 months ago
JSON representation

Example app showcasing the ngrx platform

• Host: GitHub
• URL: https://github.com/ngrx/example-app
• Owner: ngrx
• License: mit
• Archived: true
• Created: 2016-05-28T18:55:27.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-07-31T11:51:52.000Z (over 7 years ago)
• Last Synced: 2024-08-01T16:40:42.696Z (6 months ago)
• Topics: angular, ngrx, observables, redux, rxjs
• Language: TypeScript
• Homepage:
• Size: 4.78 MB
• Stars: 1,364
• Watchers: 90
• Forks: 503
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
---

# This repository is for version 2.x of the example application.

# [Click here for the latest version (4.x)](https://github.com/ngrx/platform)

---

# @ngrx example application

Example application utilizing @ngrx libraries, showcasing common patterns and best practices.

Take a look at the [live app](http://ngrx.github.io/example-app/).

This app is a book collection manager. Using the Google Books API, the user can search for

books and add them to their collection. This application utilizes [@ngrx/db](https://github.com/ngrx/db)

to persist the collection across sessions; [@ngrx/store](https://github.com/ngrx/store) to manage

the state of the app and to cache requests made to the Google Books API;

[@angular/router](https://github.com/angular/angular) to manage navigation between routes;

[@ngrx/effects](https://github.com/ngrx/effects) to isolate side effects.

Built with [@angular/cli](https://github.com/angular/angular-cli)

### Included

 - [ngrx/store](https://github.com/ngrx/store) - RxJS powered state management for Angular apps, inspired by Redux

 - [ngrx/effects](https://github.com/ngrx/effects) - Side effect model for @ngrx/store

 - [angular/router](https://github.com/angular/angular) - Angular Router

 - [ngrx/db](https://github.com/ngrx/db) - RxJS powered IndexedDB for Angular apps

 - [ngrx/store-devtools](https://github.com/ngrx/store-devtools) - Instrumentation for @ngrx/store enabling time-travel debugging

 - [codewareio/ngrx-store-freeze](https://github.com/codewareio/ngrx-store-freeze) - A @ngrx/store meta reducer that prevents state from being mutated

 - [reselect](https://github.com/reactjs/reselect) - Selector library for Redux

### Quick start

```bash

# clone the repo

git clone https://github.com/ngrx/example-app.git

# change directory to repo

cd example-app

# Use npm or yarn to install the dependencies:

npm install

# OR

yarn

# start the server

ng serve

```

Navigate to [http://localhost:4200/](http://localhost:4200/) in your browser

_NOTE:_ The above setup instructions assume you have added local npm bin folders to your path.

If this is not the case you will need to install the Angular CLI globally.