taboo-cms/README.md

Taboo CMS

# Taboo CMS

## Notes
We have finally launched new [Taboo CMS](https://www.npmjs.com/package/@taboo/cms) app together with
updated [Taboo CMS Core](https://www.npmjs.com/package/@taboo/cms-core) module.
If you are about to start new project please use this module:

[@taboo/cms](https://www.npmjs.com/package/@taboo/cms)

## Documentation
It is using Koa framework. 
In your own app you have to install it as a dependency:
```
npm i taboo-cms
```

To start the server from your own app:
```
const { start, logger } = require('taboo-cms');

start().catch(error => {
  logger.error(error);
});
```

It will read config and all modules including their config, controllers, models and services from the 
following app structure:
```
app
    assets
        fonts
        img
        scripts
        styles
    db
        adapters
        migrations
    locales
    modules
        module1
            client
                compontents
                stores
                adminClientConfig.js
            controllers
            models
            services
            config.js
    policies
    templates
        error
        layouts
config
    environment
        development.js
        production.js
        staging.js
    local.js
logs
node_modules
public
scripts
tasks
index.js
package.json
package-lock.json
README.md
```

This web app boilerplate which includes basic modules, mongodb adapter,
build and watch tasks and also React admin side is coming up pretty soon.


## CTX custom properties
```
// ctx.flashMessages
[
  {
    message: 'Your message',
    type: 'error',
  }
]

// ctx.taboo
{ 
  language: 'en',
  locale: 'en-gb',
  translations: {},
  moduleRoute: {
     method: 'GET',
     path: '/',
     action: [AsyncFunction: index],
     policies: [ 'isAuthenticated', 'i18n' ],
     order: 0,
     modulePath: '/absolute/path/app/modules/main',
  },
}

// ctx.view
{
  _view: 'viewname',
  _layout: 'layoutname',
  _clientConfig: clientConfig,
  _clientConfigJson: JSON.stringify(clientConfig),
  _version: config.version,
  _env: config.environment,
  pageTitle: config.server.views.defaultPageTitle,
  language: taboo.language,
  locale: taboo.locale,
  translations: taboo.translations,
  flashMessages: ctx.flashMessages,
  helpers: {},
  // ... all of your custom values to be used in the view
}
```