An open framework for building digital services.
semantic-release-bot chore(release): 1.74.0 [skip ci]
# [1.74.0](v1.73.0...v1.74.0) (2018-12-11)

### 🛠 Builds

* **deps:** update [@wmfs](https://github.com/wmfs)/statebox requirement from 1.39.1 to 1.40.0 ([dc64d4f](dc64d4f))
Latest commit f2f04a4 Dec 11, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
test test: update tests in line with statebox changes Nov 15, 2018
.gitignore
.releaserc.json
.travis.yml CI(travis): Update Travis config Jul 12, 2018
CHANGELOG.md
LICENSE
README.md
package.json build(deps): update @wmfs/statebox requirement from 1.39.1 to 1.40.0 Dec 11, 2018

README.md

tymly

Tymly Package npm (scoped) Build Status codecov CodeFactor Dependabot badge Commitizen friendly JavaScript Style Guide license FOSSA Status

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.tymly.io/

Tests

$ npm test

License

MIT

FOSSA Status