https://github.com/wmfs/form-maker

https://github.com/wmfs/form-maker

forms package tymly

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/wmfs/form-maker
• Owner: wmfs
• License: mit
• Created: 2018-06-20T07:40:35.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-27T21:33:02.000Z (4 months ago)
• Last Synced: 2024-10-13T14:29:07.710Z (4 months ago)
• Topics: forms, package, tymly
• Language: JavaScript
• Size: 271 KB
• Stars: 0
• Watchers: 7
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Form-maker

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

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

[![CircleCI](https://circleci.com/gh/wmfs/form-maker.svg?style=svg)](https://circleci.com/gh/wmfs/form-maker)

[![codecov](https://codecov.io/gh/wmfs/form-maker/branch/master/graph/badge.svg)](https://codecov.io/gh/wmfs/form-maker)

[![CodeFactor](https://www.codefactor.io/repository/github/wmfs/form-maker/badge)](https://www.codefactor.io/repository/github/wmfs/form-maker)

[![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/blob/master/packages/pg-concat/LICENSE)

> Generates a form and state machine in JSON format based on a given yaml.

## Tests

```bash

$ npm test

```

## Usage

```javascript

const formMaker = require('form-maker')

formMaker (

  {

    namespace: 'test', // the namespace of the model you want to save form data to

    formName: 'peopleForm', // name of the form

    modelName: 'peopleModel', // name of the model that you want to save form data to

    yamlPath: 'path/to/yaml/file'

  },

  function (err, result) {

    // result.form - holds the generated form object

    // result.stateMachine - holds the generated state machine object

  }

)

```

## License

[MIT](https://github.com/wmfs/tymly-runner/blob/master/LICENSE)