# formgun

> Fast n easy forms for the web.

Latest version **0.0.2** (published 2015-10-31) · Apache v. 2 license · 0 weekly downloads

## Install

```sh
npm install formgun
pnpm add formgun
yarn add formgun
bun add formgun
```

Provides the command `fgun`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2015-10-31 |
| First published | 2015-10-25 |
| Weekly downloads | 0 |
| License | Apache v. 2 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Joni Rajanen |
| Maintainers | jonira |

## Links

- npm: https://www.npmjs.com/package/formgun
- Repository: https://github.com/jonira/formgun
- Issues: https://github.com/jonira/formgun/issues
- npm.io page: https://npm.io/package/formgun

## Dependencies (6)

- [dot](https://npm.io/package/dot.md) ^1.0.3
- [express](https://npm.io/package/express.md) ^4.13.3
- [bluebird](https://npm.io/package/bluebird.md) ^2.10.2
- [json2csv](https://npm.io/package/json2csv.md) ^3.0.1
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [body-parser](https://npm.io/package/body-parser.md) ^1.14.1

## Recent versions

- 0.0.2 (latest) — 2015-10-31
- 0.0.1 — 2015-10-25
- 0.0.0 — 2015-10-25

## README

# Formgun

Fast & easy forms for the web.

## Installation

Formgun is a node.js module, you can install it with npm:

````npm install formgun````

## Usage

* Create a new form
````fgun create booking````

* Add some inputs
````fgun update booking --add input --name email --type string````

* Host it
````fgun host booking ````
Form will be hosted at http://localhost:3000.

### NB
shorter syntax is also supported:
````fgun update booking -a input -n email -t string````

HTML containing the form is generated under ````./booking/````

## Documentation

Command pattern is: ````fgun {create/update/host} {form-name}```` see below.

### create
Creates a new form. Form is generated under ````./{form-name}/```` directory.

### update
Update form.

* ````--add, -a ```` adds to form. Possible values: ````input````

####  adding input (````--add input````):
* ````--name, -n```` name of input
* ````--type, -t```` type of input (html5 input types)

### host
Hosts the form at http://localhost:3000. Submitted form data is saved under ````./{form-name}/formData.csv````

## License

Licensed under Apache V2

## Contributing

PRs are welcome !

---
_Source: https://npm.io/package/formgun · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
