# grunt-couchapp

> A grunt plugin for building and uploading couchapps

Latest version **0.2.1** (published 2013-10-17) · 0 weekly downloads

## Install

```sh
npm install grunt-couchapp
pnpm add grunt-couchapp
yarn add grunt-couchapp
bun add grunt-couchapp
```

Provides the command `grunt-couchapp`.

## 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.2.1 |
| Published | 2013-10-17 |
| First published | 2012-08-10 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | * |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ken Elf Mathieu Sternberg |
| Maintainers | elfsternberg, garbados |
| Keywords | gruntplugin, couchdb, couchapp |

## Links

- npm: https://www.npmjs.com/package/grunt-couchapp
- Repository: https://github.com/garbados/grunt-couchapp
- Issues: https://github.com/garbados/grunt-couchapp/issues
- npm.io page: https://npm.io/package/grunt-couchapp

## Dependencies (3)

- [nano](https://npm.io/package/nano.md) 3.3.0
- [grunt](https://npm.io/package/grunt.md) ~0.3.12
- [couchapp](https://npm.io/package/couchapp.md) 0.10.*

## Recent versions

- 0.2.1 (latest) — 2013-10-17
- 0.2.0 — 2013-09-09
- 0.1.0 — 2012-08-10

## README

# grunt-couchapp

A grunt plugin for building and installing couchapps

## Getting Started 

Install this grunt plugin next to your project's
[grunt.js gruntfile][getting_started] with: `npm install
grunt-couchapp`

Then add this line to your project's `grunt.js` gruntfile:

    grunt.loadNpmTasks('grunt-couchapp');

[grunt]: https://github.com/cowboy/grunt
[getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.md

## Documentation

You'll want to add some configuration for the plug-in.  This plugin
provides three tasks, `mkcouchdb` to create new databases, `rmcouchdb`
to delete all data and drop an existing database, and `couchapp`,
which installs a specified couchapp into the database.

    mkcouchdb: {
        demo: {
            db: 'http://localhost:5984/grunt-couchapp-demo',
            options: {
                okay_if_exists: true
            }
        }
    },

    rmcouchdb: {
        demo: {
            db: 'http://localhost:5984/grunt-couchapp-demo',
            options: {
                okay_if_missing: true
            }
        }
    },

    couchapp: {
        demo: {
            db: 'http://localhost:5984/grunt-couchapp-demo',
            app: './demo/app.js'
        }
    }

As a stylistic note, all of the commands take the same info, so it's
possible to write in your configuration file:

    couch_config = {
        demo: {
            db: 'http://localhost:5984/grunt-couchapp-demo',
            app: './demo/app.js',
            options: {
                okay_if_missing: true,
                okay_if_exists: true
            }
        }
    }

    grunt.initConfig({
        ...            
        mkcouchdb: couch_config,
        rmcouchdb: couch_config,
        couchapp: couch_config,
        ...
    });    


Note that if you call `rmcouchdb` without a sub-argument, it will not delete any databases.

## Demo

It is possible to run the entire toolchain (drop, initialize, and
install) with the grunt.js file by calling `grunt demo`.  As long as
you have a local couchdb running in admin-party mode, and browse to
`http://localhost:5984/grunt-couchapp-demo/_design/app/index.html`
You should get back a happy message.

## Contributing

In lieu of a formal styleguide, take care to maintain the existing
coding style. Add unit tests for any new or changed
functionality. Lint and test your code using [grunt][grunt].

## License
Copyright (c) 2012 Ken Elf Mathieu Sternberg  
Licensed under the MIT license.

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