rofrischmann/alveron

View on GitHub
docs/introduction/Examples.md

Summary

Maintainability
Test Coverage
# Examples

1. [Counter](#counter)
2. [TodoList](#todolist)
3. [Async API](#async-api)

## [Counter](https://github.com/rofrischmann/alveron/tree/master/examples/Counter)

<img style="border:1px solid black" src="https://raw.githubusercontent.com/rofrischmann/alveron/master/docs/res/Counter.gif">

The first example is a super basic counter.<br>
One can find the source code under [examples/Counter](https://github.com/rofrischmann/alveron/tree/master/examples/Counter).<br>
You will also find a guide how to run the example.

**It covers:**
* Model
* Actions
* Actions with Payload
* Delayed Actions using Effects

## [TodoList](https://github.com/rofrischmann/alveron/tree/master/examples/TodoList)

<img style="border:1px solid black" src="https://raw.githubusercontent.com/rofrischmann/alveron/master/docs/res/TodoList.gif">

A TodoList is a common example to showcase basic state management.<br>
One can find the source code under [examples/TodoList](https://github.com/rofrischmann/alveron/tree/master/examples/TodoList).<br>
You will also find a guide how to run the example.

**It covers:**
* Model
* Actions
* Actions with Payload
* Immutable Array Updates
* State Selection

## [Async API](https://github.com/rofrischmann/alveron/tree/master/examples/AsyncAPI)

<img style="border:1px solid black" src="https://raw.githubusercontent.com/rofrischmann/alveron/master/docs/res/AsyncAPI.gif">

This example is a bit more advanced as it included fetching data from an actual REST API.<br>
One can find the source code under [examples/AsyncAPI](https://github.com/rofrischmann/alveron/tree/master/examples/TodoList).<br>
You will also find a guide how to run the example.

**It covers:**
* Model
* Actions
* Actions with Payload
* Effects
* Data Fetching using Effects