ngxs / ngxs-examples Goto Github PK

View Code? Open in Web Editor NEW

89.0 89.0 34.0 302 KB

NGXS Example Apps

TypeScript 96.71% HTML 2.40% CSS 0.89%

examples ngxs samples

ngxs-examples's Introduction

NGXS is a state management pattern + library for Angular

Quick Links

✨ Learn about it on the docs site
🚀 See it in action on Stackblitz
😎 Checkout the sample application
🔧 Scaffolding application using NGXS Schematics
📖 Read the blog posts
⚡️ Development of NGXS Labs
📝 Learn about updates from the changelog
❤️ Give back by becoming a Contributor or a Sponsor
👂 We would love to hear about your experience with NGXS, you can leave your feedback here

The Goal of NGXS

NGXS tries to make things as simple and accessible as possible. There can be a lot of boilerplate code in state management, thus a main goal of NGXS is to reduce boilerplate allowing you to do more things with less. It is also not necessary to be super familiar with RxJs.

The Goal of NGXS Labs

The idea with this github organisation is to provide a place for the community to create libraries that augment the main framework with functionality that does not need to be integrated directly into the framework and therefore can evolve through their initial iterations of experimentation without affecting the main @ngxs/store library.

Getting Started - Local Development

Installation

To get started locally, follow these instructions:

If you haven't done it already, make a fork of this repo.
Clone to your local computer using git.
Make sure that you have installed NodeJS.
Make sure that you have yarn installed.
Run yarn install.
Run yarn build:packages.

Creating new packages or add feature/fix

if you make changes @ngxs/store

Run development mode yarn build:packages --package store --watch
Run serve integration examples yarn start
...development...
Run tests yarn test:ci
Create pull request

if you add a new package @ngxs/my-super-plugin

Create a new project folder packages/my-super-plugin
Create template library with ngPackagr
Add your project to package.json
Run development mode yarn build:packages --package my-super-plugin --watch
...development...
Run build yarn build:packages --package my-super-plugin
Run tests yarn test:ci
Create pull request

NGXS Labs

If you have ideas for creating unique libraries, you can join us. Email us at [email protected]. Or you can email us on Twitter or Slack.

Packages

Tools

Project	Package	Version	Links
NGXS CLI	`@ngxs/cli`
NGXS Schematics	`@ngxs/schematics`

Packages

Project	Package	Version	Links
NGXS Store	`@ngxs/store`
NGXS Logger-plugin	`@ngxs/logger-plugin`
NGXS Devtools-plugin	`@ngxs/devtools-plugin`
NGXS WebSocket-plugin	`@ngxs/websocket-plugin`
NGXS Form-plugin	`@ngxs/form-plugin`
NGXS Router-plugin	`@ngxs/router-plugin`
NGXS Storage-plugin	`@ngxs/storage-plugin`
NGXS HMR	`@ngxs/hmr-plugin`

NGXS Labs

Project	Package	Version	Links
NGXS-labs Data	`@ngxs-labs/data`
NGXS-labs Emitter	`@ngxs-labs/emitter`
NGXS-labs Immer adapter	`@ngxs-labs/immer-adapter`
NGXS-labs Dispatch decorator	`@ngxs-labs/dispatch-decorator`
NGXS-labs Select snapshot decorator	`@ngxs-labs/select-snapshot`
NGXS-labs Async storage plugin	`@ngxs-labs/async-storage-plugin`
NGXS-labs Entity state	`@ngxs-labs/entity-state`
NGXS-labs Testing tools	`@ngxs-labs/testing`
NGXS-labs Actions Executing	`@ngxs-labs/actions-executing`
NGXS-labs Attach Action	`@ngxs-labs/attach-action`

Community

Project	Package	Version	Links
Reset Plugin	`ngxs-reset-plugin`
NGXS-Loading-plugin	`ngxs-loading-plugin`
NGXS-History-plugin	`ngxs-history-plugin`

Contributors

Thanks to all our contributors!

ngxs-examples's People

Contributors

Stargazers

Watchers

ngxs-examples's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on Greenkeeper 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 click the 'fix repo' button on account.greenkeeper.io.

Ngxs - Autologout

This is not an issue just a request for assistance
I was wondering if you can point me at any samples that show you how to perform an auto logout after 5 minutes of inactivity?

Thanks
Damien

Action required: Greenkeeper could not be activated 🚨

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

The navigateByUrl called in @Action handler does not change the view

go to http://localhost:4200/auth/login
click on Login with Google
FAIL: you are still on the login page

At that point the URL already shows /dashboard route and it also with enabled tracing, you can see the navigation has ended successfully.

However the still appears in the DOM.

onLoginSuccess, navigating to /dashboard
platform-browser.js:380 Router Event: NavigationStart
platform-browser.js:367 NavigationStart(id: 1, url: '/dashboard')
platform-browser.js:367 NavigationStart {id: 1, url: "/dashboard"}
auth.state.ts:129 setUserStateOnSuccess
platform-browser.js:380 Router Event: RouteConfigLoadStart
platform-browser.js:367 RouteConfigLoadStart(path: dashboard)
platform-browser.js:367 RouteConfigLoadStart {route: {…}}
platform-browser.js:380 Router Event: RouteConfigLoadEnd
platform-browser.js:367 RouteConfigLoadEnd(path: dashboard)
platform-browser.js:367 RouteConfigLoadEnd {route: {…}}
platform-browser.js:380 Router Event: RoutesRecognized
platform-browser.js:367 RoutesRecognized(id: 1, url: '/dashboard', urlAfterRedirects: '/dashboard', state: Route(url:'', path:'') { Route(url:'dashboard', path:'dashboard') { Route(url:'', path:'') }  } )
platform-browser.js:367 RoutesRecognized {id: 1, url: "/dashboard", urlAfterRedirects: "/dashboard", state: RouterStateSnapshot}
platform-browser.js:380 Router Event: GuardsCheckStart
platform-browser.js:367 GuardsCheckStart(id: 1, url: '/dashboard', urlAfterRedirects: '/dashboard', state: Route(url:'', path:'') { Route(url:'dashboard', path:'dashboard') { Route(url:'', path:'') }  } )
platform-browser.js:367 GuardsCheckStart {id: 1, url: "/dashboard", urlAfterRedirects: UrlTree, state: RouterStateSnapshot}
platform-browser.js:380 Router Event: ChildActivationStart
platform-browser.js:367 ChildActivationStart(path: '')
platform-browser.js:367 ChildActivationStart {snapshot: ActivatedRouteSnapshot}
platform-browser.js:380 Router Event: ActivationStart
platform-browser.js:367 ActivationStart(path: 'dashboard')
platform-browser.js:367 ActivationStart {snapshot: ActivatedRouteSnapshot}
platform-browser.js:380 Router Event: ChildActivationStart
platform-browser.js:367 ChildActivationStart(path: 'dashboard')
platform-browser.js:367 ChildActivationStart {snapshot: ActivatedRouteSnapshot}
platform-browser.js:380 Router Event: ActivationStart
platform-browser.js:367 ActivationStart(path: '')
platform-browser.js:367 ActivationStart {snapshot: ActivatedRouteSnapshot}
platform-browser.js:380 Router Event: GuardsCheckEnd
platform-browser.js:367 GuardsCheckEnd(id: 1, url: '/dashboard', urlAfterRedirects: '/dashboard', state: Route(url:'', path:'') { Route(url:'dashboard', path:'dashboard') { Route(url:'', path:'') }  } , shouldActivate: true)
platform-browser.js:367 GuardsCheckEnd {id: 1, url: "/dashboard", urlAfterRedirects: UrlTree, state: RouterStateSnapshot, shouldActivate: true}
platform-browser.js:380 Router Event: ResolveStart
platform-browser.js:367 ResolveStart(id: 1, url: '/dashboard', urlAfterRedirects: '/dashboard', state: Route(url:'', path:'') { Route(url:'dashboard', path:'dashboard') { Route(url:'', path:'') }  } )
platform-browser.js:367 ResolveStart {id: 1, url: "/dashboard", urlAfterRedirects: UrlTree, state: RouterStateSnapshot}
platform-browser.js:380 Router Event: ResolveEnd
platform-browser.js:367 ResolveEnd(id: 1, url: '/dashboard', urlAfterRedirects: '/dashboard', state: Route(url:'', path:'') { Route(url:'dashboard', path:'dashboard') { Route(url:'', path:'') }  } )
platform-browser.js:367 ResolveEnd {id: 1, url: "/dashboard", urlAfterRedirects: UrlTree, state: RouterStateSnapshot}
platform-browser.js:380 Router Event: ActivationEnd
platform-browser.js:367 ActivationEnd(path: '')
platform-browser.js:367 ActivationEnd {snapshot: ActivatedRouteSnapshot}
platform-browser.js:380 Router Event: ChildActivationEnd
platform-browser.js:367 ChildActivationEnd(path: 'dashboard')
platform-browser.js:367 ChildActivationEnd {snapshot: ActivatedRouteSnapshot}
platform-browser.js:380 Router Event: ActivationEnd
platform-browser.js:367 ActivationEnd(path: 'dashboard')
platform-browser.js:367 ActivationEnd {snapshot: ActivatedRouteSnapshot}
platform-browser.js:380 Router Event: ChildActivationEnd
platform-browser.js:367 ChildActivationEnd(path: '')
platform-browser.js:367 ChildActivationEnd {snapshot: ActivatedRouteSnapshot}
platform-browser.js:380 Router Event: NavigationEnd
platform-browser.js:367 NavigationEnd(id: 1, url: '/dashboard', urlAfterRedirects: '/dashboard')
platform-browser.js:367 NavigationEnd {id: 1, url: "/dashboard", urlAfterRedirects: "/dashboard"}

Naming convention inconsistencies

Hi, I'm looking to use NGXS for the first time and wanted to make sure I started off my naming convention on the right foot.

In some examples, the class that houses the @selectors and @actions are suffixed with "Store" and the state models are suffixed with "State".

In other examples, those types of classes are suffixed with "State" and the state models are suffixed with "Model".

I looked at the style guide and didn't see anything specific other than the naming of the files themselves. Can someone point me in the right direction on this?

status of project 2, 3 and 4?

Are project 2, 3 and 4 not pushed? readme gives the impression that they are complete but I couldn't find them in the repo.

unit tests

This lib is really great, but I'm trying to make an effort to unit test all of my code and I was hoping to find examples of unit tests. Specifically the DI piece and mocking the NGXS pieces.

When my component constructor takes in the store as a constructor and I import NgxsModule.forRoot([MyState]) in the TestBed my tests still fail w/ "Can't resolve all parameters for ".

This would be a great repo to show how to unit test an app that uses NGXS including mocking.

ngxs / ngxs-examples Goto Github PK

ngxs-examples's Introduction

Quick Links

The Goal of NGXS

The Goal of NGXS Labs

Getting Started - Local Development

Installation

Creating new packages or add feature/fix

if you make changes @ngxs/store

if you add a new package @ngxs/my-super-plugin

NGXS Labs

Packages

Tools

Packages

NGXS Labs

Community

Contributors

ngxs-examples's People

Contributors

Stargazers

Watchers

Forkers

ngxs-examples's Issues

Recommend Projects

Recommend Topics

Recommend Org