https://github.com/wmfs/tymly-core
An open framework for building digital services.
https://github.com/wmfs/tymly-core
tymly
Last synced: 18 days ago
JSON representation
An open framework for building digital services.
- Host: GitHub
- URL: https://github.com/wmfs/tymly-core
- Owner: wmfs
- License: mit
- Created: 2018-06-11T16:17:24.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-04-29T08:06:59.000Z (about 1 month ago)
- Last Synced: 2025-04-29T09:24:07.671Z (about 1 month ago)
- Topics: tymly
- Language: JavaScript
- Homepage:
- Size: 1.67 MB
- Stars: 4
- Watchers: 6
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# tymly
[](https://tymly.io/)
[](https://www.npmjs.com/package/@wmfs/tymly)
[](https://circleci.com/gh/wmfs/tymly-core)
[](https://codecov.io/gh/wmfs/tymly-core)
[](https://www.codefactor.io/repository/github/wmfs/tymly-core)
[](https://dependabot.com/)
[](http://commitizen.github.io/cz-cli/)
[](https://standardjs.com)
[](https://github.com/wmfs/tymly/blob/master/packages/pg-concat/LICENSE)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fwmfs%2Ftymly-core?ref=badge_shield)
> A framework for building and sharing workflows in Node.js.
## Install
```bash
$ npm install tymly --save
```
## Usage
```javascript
const tymly = require('tymly')
const tymlyServices = await 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
],
excludeBlueprints: 'the-thing-that-should-not-be-blueprint'
// 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
],
excludePlugins: 'the-thing-that-should-not-be-plugin'
}
)
// Do something with those services...
// (e.g. the 'tymly-express-plugin' provides an Express-powered 'server' service)
const port = 3000
services.server.listen(port, () => {
console.log(`Example app listening on port ${port}`);
})
```
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.
For documentation, please visit http://www.tymly.io/
## Tests
```bash
$ npm test
```
## License
[MIT](https://github.com/wmfs/tymly/blob/master/LICENSE)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fwmfs%2Ftymly-core?ref=badge_large)