trailpack-treefrog
v2.0.0
Published
Structured frontends in Angular 2 or React for Trailsjs apps
Downloads
5
Maintainers
Readme
trailpack-treefrog
Structured frontends in Angular2, React, or whatever for Trailsjs Apps.
The beauty of Javascript is the ability to build isomorphic apps. Treefrog is focused on that concept.
Looking for the Style Library? Checkout https://github.com/CaliStyle/treefrog
Looking for the generator? Checkout https://github.com/CaliStyle/trailpack-treefrog.
##Isomorphic Apps For a great explanation of what an Isomorphic app is, check out https://www.lullabot.com/articles/what-is-an-isomorphic-application.
Why Isopmorphic apps? If your app has a frontend, then you can save time by reusing code. On top of that, Search Engine Optimzation and Mobile Optimzation aren't going away and Isomorphic apps benefit from the speed boost of having an app fully rendered on demand.
Status
Stability: 1 - Experimental
Install
// Install the Trailpack with NPM
$ npm install --save trailpack-treefrog
// OR Install the Trailpack with Yoeman
$ yo trails:trailpack trailpack-treefrog
//Install the Generator
$ npm install generator-treefrog -g
//Setup the frontend
$ yo treefrog
Configure
Running yo treefrog
will prompt you to configure your app like a normal Trails App with some added sugar.
It will add trailpack-treefrog
to your config/main.js
,
exports.treefrog = require('./treefrog')
to your config/index.js
,
and create/configure config/treefrog.js
.
The Generator will also use your configuration to build an archetype and install your packages automatically.
// The result of running `yo treefrog`
// config/main.js
module.exports = {
packs: [
// ... other trailpacks
require('trailpack-treefrog')
],
paths: {
// ... other paths
}
}
This process allows yo to run the generator subsequently with your saved preferences.