nhagen / marty-koa Goto Github PK

express middleware for building isomorphic applications with Marty & react-router.

##Usage

var Marty = require('marty');
var Router = require('react-router');
var RouteHandler = Router.RouteHandler;

var routes = (
  <Route handler={RouteHandler}>
    <Route name='foo' path='/foo/:id' handler={Foo} />
    <Route name='var' path='/bar/:id' handler={Bar} />
  </Route>
);

var app = express();

app.use(require('marty-express')({
  routes: routes, // required
  view: 'foo', // name of view to render, default: index
  local: 'bar', // name of local variable in view, default: body
  marty: ..., // instance of Marty to use, default: require('marty')
}));

##Quick start

make bootstrap      #Install all dependencies
make test           #Run tests

##Git Commit Messages

• Use the present tense ("Add feature" not "Added feature")
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
• Limit the first line to 72 characters or less
• Reference issues and pull requests liberally
• Consider starting the commit message with an applicable emoji:
  • 💄 :lipstick: when improving the format/structure of the code
  • 🐎 :racehorse: when improving performance
  • 🚱 :non-potable_water: when plugging memory leaks
  • 📝 :memo: when writing docs
  • 🐧 :penguin: when fixing something on Linux
  • 🍎 :apple: when fixing something on Mac OS
  • 🏁 :checkered_flag: when fixing something on Windows
  • 🐛 :bug: when fixing a bug
  • 🔥 :fire: when removing code or files
  • 💚 :green_heart: when fixing the CI build
  • ✅ :white_check_mark: when adding tests
  • 🔒 :lock: when dealing with security
  • ⬆️ :arrow_up: when upgrading dependencies
  • ⬇️ :arrow_down: when downgrading dependencies

(From atom)

##Maintainers

• James Hollingworth

##License

• MIT