redux-elm-boilderplate

WORK IN PROGRESS

A highly modular structure based on redux-elm (Elm architecture for Redux) and react-boilerplate (most popular Redux foundation).

_{Made with ❤︎ by Jan Grzegorowski.}

Features

Ultimate modularization

Thanks to Elm Architecture create easily manageable and reusable containers which builds your App.

Quick scaffolding (work in progress)

Create components, containers, routes, selectors and sagas - and their tests - right from the CLI!

Instant feedback

Enjoy the best DX (Developer eXperience) and code your app at the speed of thought! Your saved changes to the CSS and JS are reflected instantaneously without refreshing the page. Preserve application state even when you update something in the underlying code!

Predictable state management

Unidirectional data flow allows for change logging and time travel debugging.

Next generation JavaScript

Use template strings, object destructuring, arrow functions, JSX syntax and more, today.

Next generation CSS

Write composable CSS that's co-located with your components for complete modularity. Unique generated class names keep the specificity low while eliminating style clashes. Ship only the styles that are on the page for the best performance.

Industry-standard routing

It's natural to want to add pages (e.g. `/about`) to your application, and routing makes this possible with react-router-redux.

Offline-first

The next frontier in performant web apps: availability without a network connection from the instant your users load the app.

Managable form state

Creating complex forms was never been easier. The best way to manage your form state in Redux is redux-form.

But wait... there's more!

• The best test setup: Automatically guarantee code quality and non-breaking changes. (Seen a react app with 99% test coverage before?)
• Native web app: Your app's new home? The home screen of your users' phones.
• The fastest fonts: Say goodbye to vacant text.
• Stay fast: Profile your app's performance from the comfort of your command line!
• Catch problems: AppVeyor and TravisCI setups included by default, so your tests get run automatically on Windows and Unix.

_{Keywords: React.js, Redux, Hot Reloading, ESNext, Babel, PostCSS, Autoprefixer, react-router, Offline First, ServiceWorker, CSS Modules, redux-saga, FontFaceObserver, PageSpeed Insights, Redux Elm Architecture, redux-elm}

Quick start

1. Clone this repo using $ git clone --depth=1 https://github.com/jmarceli/redux-elm-boilerplate.git
2. Run $ npm install to install dependencies
3. Run $ npm start to run example app

Documentation

WORK IN PROGRESS

- [Intro](docs/general): What's included and why - [**Commands**](docs/general/commands.md): Getting the most out of this boilerplate - [Testing](docs/testing): How to work with the built-in test harness - [Styling](docs/css): How to work with the CSS tooling - [Your app](docs/js): Supercharging your app with Routing, Redux, simple asynchronicity helpers, etc.

License

This project is licensed under the MIT license, Copyright (c) 2016 Jan Grzegorowski. For more information see LICENSE.md.

TODO

• improve/update documentation
• create generators like in original react-boilerplate
• add more tests