VojtechBartos/este

Dev stack and starter kit for functional and universal (browser, server, mobile) React apps

Happily maintained dev stack and starter kit for React universal apps. One stack for browser, server, mobile.

Forget about evil frameworks, use laser focused libraries and design patterns instead.

Techniques

• Truly universal architecture
  • code shared across platforms (browser, server, native mobile)
  • server side rendering
  • universal data fetching via one higher order component
  • prerender for static hosting
• Functional architecture (immutability, hot reload, time traveling)
• Test driven development ready
• Advanced performance with pure components
• Well tuned dev stack
• Universal forms with validation
• Firebase integration (este.firebaseapp.com)

Libraries

• React and React Native
• Redux
• babeljs
• immutablejs
• react-router
• webpack
• expressjs
• eslint
• formatjs Universal internationalization.
• React Helmet A document head manager for React.
• webpack-isomorphic-tools
• chriso/validator.js For simple yet powerfull Este sync/async validation.
• bluebird Because it's better than native implementation.
• mochajs The fun, simple, flexible JavaScript test framework.
• LESS, SASS, Stylus, or plain CSS with autoprefixer
• shortid Short id generator. Url-friendly. Non-predictable.
• gulp For cross platform scripting.
• And much more. Check source code.

Prerequisites

• node.js (Node 5 with npm 3 is required).
• gulp (npm install -g gulp)

If you are using different node versions on your machine, use nvm to manage them.

Create App

git clone https://github.com/este/este.git este-app
cd este-app
npm install

Start Development

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

React Native: facebook.github.io/react-native/docs/getting-started.html

Dev Tasks

• gulp run web app in development mode
• gulp -p run web app in production mode
• gulp mocha run mocha unit tests
• gulp mocha-watch continuous test running for TDD
• gulp eslint eslint

Production Tasks

• gulp build -p build app for production, for example for Heroku
• npm test run all checks and tests
• node src/server start app, remember to set NODE_ENV and SERVER_URL
• gulp to-html render app to HTML for static hosting like Firebase

Documentation

For absolute beginners: react-howto.

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 and Redux. Refresh you JavaScript knowledge about "new" JavaScript - learn ES6. This stack uses immutable.js and class-less design for a good reason. Express.js is used on the Node.js based server. Application is universal, so we can share code between browser, server, mobile, whatever easily. Congrats, you're Este.js expert level 1 now :-)

Links

• wiki
• twitter.com/estejs

Windows

Use this if you are using JEST or another library, which has to be compiled.

• 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

Tips and Tricks

• To check current app state, just open browser console.
• Install Redux devtools Chrome extension zalmoxisus/redux-devtools-extension
• With functional programming (SOLID: the next step is Functional), we don't need DI containers. We can use plain old Pure DI. Check injectMiddleware in configureStore.
• Learn immutable.js, for example Seq. Handy even for native arrays and objects. For example, get object values: Seq(RoomType).toSet().toJS()
• Recommended editors are sublimetext (tips) and atom.io.

FAQ

Why do I get EACCES error during npm install?

This indicates that you do not have permission to write to the directories that npm uses to store packages and commands. One possible solution is to change the permission to npm's default directory.

1. Find the path to npm's directory: npm config get prefix For many systems, this will be /usr/local
2. Change the owner of npm's directory's to the effective name of the current user

sudo chown -R `whoami` <directory>

Why does the CSS flicker when starting the app/refreshing it?

In dev mode, webpack loads all the style inline, which makes them hot reloadable. This behaviour disappears in production mode (gulp -p).

Does Hapi/SailJS/Restify/Rails work with Este? Do you have any example app for this framework?

Yes it does. Este is agnostic of what you use in your backend and is completely decoupled from the API. It uses an Express app for server-side rendering, but you can use anything for your API. The only benefit that an Express API has is that it can simply be use() by the main app, like any other middleware.

Is it possible use XXX library with Este?

Yes. Este makes little assumptions about your stack, and passing every bit of needed info through props. This is not a framework, nothing prevents you from picking the bits you're interested in.

How React Native is used in this project?

Just as regular React Native project created via react-native init AwesomeProject. We can easily share modules across platforms. But remember to check gulpfile.babel.js for details.

Training

• learn-reactjs.com
• javascript-skoleni.cz
• DzejEs.cz - czech articles about Este

Notes

• Este.js dev stack works on OSX, Linux, and Windows.
• As a rule of thumb, Este.js supports all evergreen browsers plus last two pieces of IE.
• Support Este.js development via Bitcoin - daniel.steigerwald.cz/#donate-estejs

Credit

made by Daniel Steigerwald, twitter.com/steida and the community