Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
The most complete React/Flux dev stack and starter kit for isomorphic functional web apps
JavaScript CSS

Merge pull request #231 from ironer/master

Fixed failing tests - missing semicolon
latest commit 2a69aa4dbd
@steida authored

README.md

Este.js

Circle CI Join the chat at https://gitter.im/steida/este Dependency Status Deploy

The most complete React/Flux dev stack and starter kit for isomorphic functional web apps. Forget about evil frameworks, learn laser focused libraries and patterns instead.

Forget about PHP/Ruby/Angular/Backbone whatever client or server only framework. Also, we don't need yet another Flux library, vanilla Flux is good enough. This dev stack is web dev panacea, at least for me :-)

Techniques

  • ECMAScript 6/7 via the best transpiler babeljs.io. JSX and Flowtype syntax supported. Sourcemaps are enabled by default.
  • Isomorphic architecture with server side rendering.
  • Immutable and functional design. Class is leaky abstraction for "business model".
  • Well tuned webpack devstack with handy notifier.
  • Webpack css livereload with hot module reload even for React components.
  • eslint ES6 linting with React JSX support. (Sublime Text 3 integration)
  • Localization with formatjs.io, stale browsers supported as well.
  • react-router for routing on client and server side.
  • Simple yet powerfull sync/async validation based on famous chriso/validator.js
  • Authentication form and reusable auth higher order component to protect access to specific components.
  • React with Flux with immutable global app state like Om.
  • Vanilla Flux, we don't need over abstracted frameworks.
  • Easy undo/redo and app state load/save.
  • jest unit testing.
  • Super fast rendering with immutable.js.
  • ftlabs/fastclick for fast click on touch devices
  • LESS, SASS, Stylus, or plain CSS with autoprefixer.
  • Google Analytics preconfigured.

Prerequisites

Install iojs or node.js. Then install gulp.js.

npm install -g gulp

Windows

  • Install Python - Install version 2.7 of Python and add it to your path or/and create a PYTHONPATH environment variable.
  • Install Visual Studio (Express Edition is fine) - We will need this for some of modules that are compiled when we are installing Este. Download VS Express, get one of the versions that has C++ - Express 2013 for Windows Desktop for example.
  • Set Visual Studio Version Flags - We need to tell node-gyp (something that is used for compiling addons) what version of Visual Studio we want to compile with. You can do this either through an environment variable GYP_MSVS_VERSION. If you are using Express, you have to say GYP_MSVS_VERSION=2013e.

Thanks to Ryanlanciaux

Create App

git clone https://github.com/steida/este.git myapp
cd myapp
npm install

Start Development

  • run gulp
  • point your browser to localhost:8000
  • build something beautiful

Dev Tasks

  • gulp run app in development mode
  • gulp -p run app in production mode
  • gulp test

CI Tasks

  • npm start just run app, remember to set NODE_ENV=production and others environment variables.
  • npm postinstall just alias for gulp build --production, useful for Heroku.
  • npm test just alias for gulp test

Examples

Documentation

So you decided to give a chance to this web stack, but where is documentation? Code is documentation itself as it illustrates various patterns, but for start you should read something about React.js. Then you should learn what is the Flux application architecture. Now refresh you JavaScript knowledge about "new" JavaScript - learn ES6. This stack uses immutable.js and class-less design for a good reason. Check this nice short video, wouldn't be possible with classic OOP classes everywhere approach. Functional programming is a next (current) big thing, read why. Express.js is used on the Node.js based server. Application is isomorphic, so we can share code between client and server easily. Congrats, now you're Este.js expert level 1 :-)

Links

Tips and Tricks

  • Whole app state is stored in one immutable app state object. To get snapshot, press shift+ctrl+s, then open dev console and type _appState.
  • With global app state, we don't need IoC container so badly - SOLID: the next step is Functional. Still DI is relevant for some cases and then use Pure DI.
  • Use const by default, let if you have to rebind a variable.
  • Learn and use immutable Seq. Very handy for native arrays and objects. For example, get object values: Seq(RoomType).toSet().toJS()
  • Even though we can use import {canUseDOM} from 'react/lib/ExecutionEnvironment' to detect browser/server, don't do it since it's runtime value. Use webpack DefinePlugin to set process.env.IS_BROWSER rather, because compilation removes dead code.
  • How to use Closure Tools, gist
  • Recommended editor is atom.io (tips) or sublimetext.

Training

Notes

  • Este.js dev stack should work on OSX, Linux, and even Windows. Feel free to report any issue.
  • As a rule of thumb, Este.js supports all evergreen browsers plus last two pieces of IE.

Credit

Este.js

made by Daniel Steigerwald, twitter.com/steida

Something went wrong with that request. Please try again.