Nobody Peels Mangoes

    This package has been deprecated

    Author message:

    WE'VE MOVED TYMLY TO @wmfs/tymly PLEASE USE THAT INSTEAD!

    tymly

    0.0.17 • Public • Published

    tymly

    JavaScript Style Guide license

    A framework for building and sharing workflows in Node.js.

    Install

    $ npm install tymly --save

    Usage

    const tymly = require('tymly')
     
    tymly.boot(
      {
        // Blueprints are structured directories that describe a business function.
        // They contain 'state-machines' (e.g. Finite State Machines expressed in JSON as per Amazon State Machine specification: http://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-state-machine-structure.html)
        // along with the resources required for those state-machines to run (e.g. data 
        // model definitions, images, form-layouts, templates etc.)
        // This is just a simple list of directories where blueprints can be found...   
        blueprintPaths: [
          '/tymly/blueprints/hr',      // Some flows for HR-related things
          '/tymly/blueprints/payroll'  // Some flows for payroll-related activities 
        ],
     
        // Tymly is extended via plugins, each in-turn offer 'services' and other components...
        pluginPaths: [
          '/tymly/plugins/tymly-express-plugin',  // For accessing Tymly over HTTP/REST etc.
          '/tymly/plugins/tymly-etl-plugin',   // Adds import-from-CSV capabilities
          '/tymly/plugins/tymly-pg-plugin'   // Persist to PostgreSQL instead of the default in-memory solution 
        ],
        
      },
      
      // Callback once everything has booted (or not)
      function (err, services) {   
        if (err) {
          // Handle something going wrong
          console.error(err)
        } else {
          // Do something with those services...
          // (e.g. the 'tymly-express-plugin' provides an Express-powered 'server' service)
          const port = 3000
          services.server.listen(port, function () {        
            console.log('Example app listening on port ' + port);       
          })  
        }   
      }
    )

    Why?

    Tymly has been developed as an alternative for organisations (especially non-profits and Government departments) who need continually-evolving business software - but can do without the complexity, expense and vendor lock-in that usually accompanies it.

    Documentation

    For documentation, please visit http://www.tymlyjs.io/

    Tests

    $ npm test

    License

    MIT

    Keywords

    none

    Install

    npm i tymly

    DownloadsWeekly Downloads

    0

    Version

    0.0.17

    License

    MIT

    Unpacked Size

    214 kB

    Total Files

    196

    Last publish

    Collaborators

    • timneedham