https://github.com/wmfs/tymly-express-plugin

https://github.com/wmfs/tymly-express-plugin

plugin tymly

Last synced: 22 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/wmfs/tymly-express-plugin
• Owner: wmfs
• License: mit
• Created: 2018-06-12T14:34:37.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-11-10T11:58:39.000Z (about 1 year ago)
• Last Synced: 2024-12-09T23:52:15.971Z (about 2 months ago)
• Topics: plugin, tymly
• Language: JavaScript
• Size: 1.02 MB
• Stars: 0
• Watchers: 7
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tymly-express-plugin

[![Tymly Plugin](https://img.shields.io/badge/tymly-plugin-blue.svg)](https://tymly.io/)

[![npm (scoped)](https://img.shields.io/npm/v/@wmfs/tymly-express-plugin.svg)](https://www.npmjs.com/package/@wmfs/tymly-express-plugin)

[![CircleCI](https://circleci.com/gh/wmfs/tymly-express-plugin.svg?style=svg)](https://circleci.com/gh/wmfs/tymly-express-plugin)

[![codecov](https://codecov.io/gh/wmfs/tymly-express-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/wmfs/tymly-express-plugin)

[![CodeFactor](https://www.codefactor.io/repository/github/wmfs/tymly-express-plugin/badge)](https://www.codefactor.io/repository/github/wmfs/tymly-express-plugin)

[![Dependabot badge](https://img.shields.io/badge/Dependabot-active-brightgreen.svg)](https://dependabot.com/)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/wmfs/tymly-express-plugin/blob/master/LICENSE)

> Exposes the [TymlyJS](http://www.tymlyjs.io) platform via an Express.js web app.

## Proxy Configuration

This plugin provides a state resource that allows a state machine to get data from a rest API.  If you are behind a firewall which, you may optionally set the PROXY_URL environment variable.  This url will should look something like 'http://[USERNAME]:[PASSWORD]@[PROXY HOST]:[PROXY PORT]'.

Note that if your on a Active Directory network, your username may need to be prefixed with a domain, followed by the three characters '%5C', to separate the domain from the username.

So for example, if your domain is called 'WORLD', your username is 'j.smith', your password is 'superhero', your proxy host is 'proxy.world.net' and your proxy port is 1234, your proxy url would look like "http://world%5Cj.smith:[email protected]:1234".

## Tuning

By default, when invoking external web API calls, a timeout is set to 3 seconds, but this can be overridden via the optional WEB_API_TIMEOUT_IN_MS environment variable.

## License

MIT