Aurelia Store Plugin examples
Switch branches/tags
Nothing to show
Clone or download

README.md

Aurelia Store Examples

Examples for the Aurelia-Store plugin.

Hosted samples

Module based splits

  • Each module of the app is a feature
  • State slices per module
  • Modules work on the plucked state-slice

Usage

  • Clone this repo
  • Navigate to a subfolder of a sample [contacts, electron, immer, ...] in your command line
  • Run npm install, or alternatively if you're using Yarn yarn install
  • Run npm start, which in turn runs au run --watch
  • Open your browser and navigate to http://localhost:9000

If au run does not work, make sure to install aurelia-cli globally via npm install -g aurelia-cli or respectively yarn global add aurelia-cli if you're using Yarn.

Markdown

A simple markdown editor with history support

  • TypeScript with WebPack using the Aurelia CLI
  • Aurelia-Store using a StateHistory

Contacts app

A copy of the official Aurelia Contacts App, this time using the Aurelia-Store Plugin though.

  • JavaScript with RequreJS and Aurelia CLI
  • Simple Aurelia-Store demonstration
  • Multiple actions
  • Router / State sync

Todo

A todo app showing the basics of the Store plugin from the perspective of a Vuex developer

  • JavaScript with WebPack using the Aurelia CLI
  • Vuex based structuring approach (mutations, actions)
  • Uses Aurelia-UX

Originally from https://github.com/Vheissu/aurelia-store-todo

There will be some warnings emitted by Webpack with regards to the css-loader, which are a known issue in the current Aurelia-UX status.

Vis

Minimal example of integrating vis.js with an Aurelia Store powered app and visualizing searched GitHub users.

  • JavaScript with WebPack using the Aurelia CLI
  • Higher Order Actions (passing in external services like HTTP)
  • Async Actions
  • Waiting for actions to complete

Electron

A minimal electron demo, firing desktop notifications.

There seems to be an issue with Win10 Fall Creators update which does not allow Notifications, thus a tray balloon is used on win platform.

  • JavaScript with WebPack using the Aurelia CLI
  • Adapted tasks to run Electron app right after starting the webpack devserver
  • Registering a middleware, to propagate state changes via ipcRenderer to the main process
  • Preinstalled Redux DevTools Extension. Integrated with the embedded Chrome Devtools (open Redux tab).

Immer

Tired of Object.assign? Take a look at this demo to see how to use Immer with Aurelia-Store.

  • TypeScript with RequireJS using the Aurelia CLI
  • Usage of Immer to avoid having to manually create immutable clones.

Services

Showcase of how to use a classic existing Service with the Aurelia-Store approach

  • TypeScript with RequireJS
  • Old-school services used in actions
  • Shows the use of dispatchify

Call to action

Any feedback or ideas are welcome so hop over to the issues section and share your words. If you have an own Aurelia Store based example app, you'd like to share, we'd be happy to see a PR.