README

generator-turris

Yeoman generator for ES6 React web applications

About Turris.js

Turris.js is a combination of existing libraries and tools that allows fast and simple creation of single page web applications using ES6.

Turris.js is built using React.js with react-router and Twitter Bootstrap CSS.
All of the application code is managed and compiled by Webpack and minified using Uglify.js (when not in debug mode).
NPM is used for the dependency management.

Gulp.js is used as a build-tool.
Testing is done using eslint for linting and code-style and mocha.js with should.js for automated testing.

Standalone reusable components for your Turris application can be generated using separate Turris-component generator.

Getting Started

Requirements

For Turris.js to function properly, you'll need to have following things installed:

io.js v1.8+
NPM v2.8+

Alternatively you can use docker environment provided by turris:docker generator.

Installation

$ npm install -g yo generator-turris

Usage

$ yo turris

API

$ yo turris
Creates a new turris.js application.

$ yo turris:component myName
Generates a new inlined React component named myName. If you want to generate standalone/self-contained and more sophisticated components, look into using Turris component generator.

$ yo turris:page myName
Generates a new page named myName and injects it into main app. The only difference between page and component is that page generates and exports a route.

$ yo turris:docker
Generates a docker environment for the project with all the requirements included.

$ yo turris:docker-deploy
Generates a separate docker environment for the project statical deployment via nginx. To deploy the app using it, you will need to:

Compile your app using npm run deploy command
Package it into docker container using docker build -t app-name -f Dockerfile-deploy . command
Run it on docker and forward port 80

Learning Your Way Around

Once installed, you can create a basic application by following the prompts.

$ mkdir HelloWorld
$ cd HelloWorld
$ yo turris

     _-----_
    |       |    .--------------------------.
    |--(o)--|    |      Welcome to the      |
   `---------´   |    breathtaking Turris   |
    ( _´U`_ )    |        generator!        |
    /___A___\    '--------------------------'
     |  ~  |
   __'.___.'__
 ´   `  |° ´ Y `

? Your project name: (HelloWorld)
...

To run your application, just type npm start.

Project Structure

Client:

/style/ - LESS files
/src/index.js - App entry point
/src/app.jsx - React app bootstrapper
/src/routes.js - Routes for react-router
/src/app/ - React app definition with react-router setup
/src/components/ - React components folder
/src/components/chrome - Application chrome React component
/src/components/navigation - Application navigation bar React component
/src/pages/ - React pages folder
/src/pages/index - Index page that's loaded by default
/src/pages/other - Other page that's added for convenience

Components (can be generated with turris:component):

/src/components/COMPONENT/index.js - React component definition
/src/components/COMPONENT/template.jsx - React template

Pages (can be generated with turris:page):

/src/pages/PAGE/index.js - React component and route definition
/src/pages/PAGE/template.jsx - React template

Misc:

/gulp/ - Custom Gulp tasks
/tests/ - Unit and functional tests
/buildConfig.js - Build config
/gulpfile.js - Gulp bootstrapper
/webpack.config.js - Webpack config for development
/webpack.config.prod.js - Webpack config for production

Docker

You can as well quickly setup a docker container that includes all the required packages for Turris.js app to work (assuming you have docker installed).
To do so, follow the steps below:

Run yo turris:docker to generate all the required docker files
Run docker build -t appname . to generate new docker container
Run docker run -it -p 8080:8080 appname to launch generated container

TODO

Add more docs, subgenerators and a proper test suite.

License

MIT

Usage no npm install needed!