sethbergman / ngrx-books

A book collection manager built with ngrx libraries for reactive state management | http://ngrx-books.npmstack.com

ngrx-books

This example application utilizes @ngrx libraries while showcasing common patterns and best practices.

Take a look at the live 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.

Included

• ngrx/store - RxJS powered state management for Angular apps, inspired by Redux
• ngrx/effects - Side effect model for @ngrx/store
• angular/router - Angular Router
• ngrx/db - RxJS powered IndexedDB for Angular apps
• ngrx/store-devtools - Instrumentation for @ngrx/store enabling time-travel debugging
• codewareio/ngrx-store-freeze - A @ngrx/store meta reducer that prevents state from being mutated
• reselect - Selector library for Redux

Setup Instructions

• The setup instructions assume you have added the Angular CLI globally.
• If this is not the case you will need to install the Angular CLI:

npm install -g @angular/cli

• Clone the repo:

git clone https://github.com/sethbergman/ngrx-books.git

• Change to the repo directory and install the dependencies:

cd ngrx-books && npm i

• Start the server:

ng serve

• Navigate to http://localhost:5000/ in your browser.

Production Build

• Run the build command:

npm run build

• Start the server:

npm start

---

@TODO:

• Implement user auth and login pages
• Implement better state management
• Include deployment instructions
• Add CONTRIBUTING.md page
• Add waffle board
• Add Slack team invitation
• Add dependencies manager
• Add documentation
• Write tutorial blog post

Want to contribute?

Pull Requests are encouraged! 🚀

ngrx-books's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.