cleverstack / backend-example-module

An example module for the Cleverstack backend. Use this as a reference for making your own module.

CleverStack Example Backend Module

This CleverStack module is designed to help show you how to make backend modules that are cleverstack supported.

Documentation

See cleverstack.io for more detailed information on the Node seed or visit the Getting Started Guide

Configuration

Simply add the following config to your /config/local.json (or into your global.json for all environments, or in whatever environment you are using).

Configuration files

{
    "backend-example-module": {
        "driver": "ORM"
    },
    "clever-background-tasks": {
        "enabled" : true,
        "interval": 2500,
        "tasks":[
            { "name": "ExampleTask", "parallel": true, "numWorkers": 2 }
        ],
        "driver": "redis",
        "redis": {
            "host": "localhost",
            "port": "11211"
        }
    }
}

Setup

Using CLI

1. Run clever install backend-example-module and follow the prompts
2. Run clever serve to start your application.

Without CLI

1. Clone this repo (or untar it there) into your modules folder (ie modules/backend-example-module)
2. Add 'backend-example-module' to the bundledDependencies array of your app's package.json.
3. Run grunt server to start your application.

License

See our LICENSE