Find file History
Latest commit d95f9b9 Dec 15, 2016 @kyldvs kyldvs committed on GitHub New Examples (#379)
* Removes all examples

* Adds flux-shell

* Add flux-shell readme

* Adds start of flux-todomvc

* Set up first steps of flux-todomvc

* Updates flux-todomvc readme

* Updates flux-todomvc readme

* Updates flux-todomvc readme

* Adds setup flux step to flux-todomvc

* Add prerequisites section to flux-todomvc readme

* Add rendering some todos step

* Add interactivity

* Add new todo functionality

* Add deleteCompletedTodos

* Add mark all as complete button

* Add edit functionality to todos

* Fixes formatting in readme

* Add flux-flow example

* Add flow annotation to flow example files

* Import react

* Update flow example

* Update flow example

* Add todos for future examples

* Add logging example

* Update to todomvc readme

* Add flux-jest example

* Fix wording

* add reference to TodoStore

* Add more context to the comment

* Update flux-flow readme

* Add note about explicit import to fluxlogging readme

* Add flux-jest-container example

* Fix typos

* Copy todomvc and add server impl

* update app.js

* async example, first pass

* Delete incorrect readme

* nit

* remove unnecessary flow ignore

* Add fake errors and handling in async example

* Finish async code

* Update async example readme

* Add flux concepts

* Update flux-concepts

Summary of different concepts

* Update flux-concepts

Mention that there should be many stores.

* Add files via upload

* Update flux-concepts

Minor changes, and adds diagram.

* Add link to flux-concepts in flux-todomvc

* Update README.md

* Add disclaimer to flux-async

* Clean up website docs, and point to new examples

README.md

Examples

This directory contains examples that should help get you started with Flux. They are listed in the order you should complete them.

./flux-concepts - Basic concepts (no code)

These are the important high-level concepts and principles you should know about when writing applications that use Flux.

./flux-todomvc - Start coding here

This example is where you should start. It walks you through creating the classic TodoMVC application using a simple Flux implementation.

./flux-jest - Unit Testing Stores

Being able to unit test stores is critical. This example shows you how to write tests for the TodoMVC stores we created in an earlier example.

./flux-flow - Static typing

This is a very simple example that highlights how to set up Flux and Flow in the same project. Flow is a static-type checking tool that will help catch errors in your code statically. It complements Flux well since it supports refining the action based on a type string.

./flux-logging - Add logging to Flux apps

Taking advantage of the fact that a store gets every action makes it easy to add logging to a Flux application. Check out this quick example where we add a logger store to the TodoMVC app we created in an earlier example.

./flux-jest-container - Unit Testing Containers

Testing the container logic that connects stores to views can be tricky. This example shows you how to create some utilities to help mock out store data in order to write these kinds of tests effectively.

./flux-async - Flux with async requests

This is an advanced example. It pulls a lot of the concepts from previous examples into a single application. This implements TodoMVC where the data is persisted and requested through a simple server. The server simulates delays and errors. In the example we will handle things like optimistic updates, loading states, and failing API requests.