cerebral-modules

cerebral-modules

Create cerebral modules that can be reused, shared, imported or just simply keep your app tidy.

Creating a module

A module needs to export the following:

export default {
  name: 'uniqueModuleName',
  isService: false, //service modules do not affect the activeModule state
  chains: {
    init: [] // init chain will be execute on app start
    // other exposed chains
  },
  // optional root component
  Component: ModuleIndexComponent
}

Loading modules

From your main.js

// import your cerebral controller
import controller from './controller';

// import you app modules
import external form 'external-node-module';
import home from './modules/home';
import notFound from './modules/notFound';

// init the modules
import setupModules from 'cerebral-modules';
const chains = setupModules(controller, [ external, home, notFound ]);

// use the chains to setup your routing here
// chains.moduleName.chainName

Contribute

Fork repo

• npm install
• npm run dev runs dev mode which watches for changes and auto lints, tests and builds
• npm test runs the tests
• npm run lint lints the code
• npm run build compiles es6 to es5