# couchappjs

> Couchapp kind of in nodejs

Latest version **0.0.2** (published 2015-11-28) · MIT license · 0 weekly downloads

## Install

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

Provides the command `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.0.2 |
| Published | 2015-11-28 |
| First published | 2014-11-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Loïc Faure-Lacroix |
| Maintainers | llacroix |

## Links

- npm: https://www.npmjs.com/package/couchappjs
- Repository: https://github.com/llacroix/couchappjs
- Homepage: https://github.com/llacroix/couchappjs#readme
- Issues: https://github.com/llacroix/couchappjs/issues
- npm.io page: https://npm.io/package/couchappjs

## Dependencies (9)

- [mime](https://npm.io/package/mime.md) ^1.2.11
- [nano](https://npm.io/package/nano.md) ^6.1.5
- [bower](https://npm.io/package/bower.md) ^1.3.12
- [watch](https://npm.io/package/watch.md) ^0.13.0
- [yargs](https://npm.io/package/yargs.md) ^1.3.2
- [colors](https://npm.io/package/colors.md) ^1.0.3
- [prompt](https://npm.io/package/prompt.md) ^0.2.14
- [promise](https://npm.io/package/promise.md) ^6.0.1
- [chokidar](https://npm.io/package/chokidar.md) ^0.10.2

## Recent versions

- 0.0.2 (latest) — 2015-11-28
- 0.0.1 — 2014-11-02
- 0.0.0 — 2014-11-01

## README

# Couchapp

Couchappjs is inspired by the couchapp program written in Python.
The idea of both program are the same except that the nodejs version
might bring some more improvement that are unlikely to happen with the 
python version.

Couchappjs currently handles those functions
    
- filters
- views
- updates
- shows
- lists

It also support loading CommonJS modules into couchdb. CommonJS modules are
currently scoped into "commonjs/*". But that could be changed in the future to
give a bit more control over how the design documents should endup.

The other big point is that Bower can be integretaded without much problems
into the couchapp API.

# Installation

You can install it globally using npm

    npm install -g couchapp

# Usage

There are currently only 2 functions

## couchapp init

Initialize the project in a folder of the name of the project. It generates a file
named `couchapp.json` that contains the configurations necessary to push the project
on the database.


### useBower

When true, push file contained in bower_components that are necessary for the
application. It use the main attribute in bower.json contained in `attachments/`. 
If useBower is false, it will add any file contained inside `attachments/`.


## couchapp sync

Used to sync the application to the database. By default it use the dev target
that is located in `couchapp.json` file.

Options:

- --pretend, -p Pretend to push to the server but instead just render the document to stdout Can be used for debugging
- --watch, -w Watch the current directory for any changes and rebuild the design document

# TODO

- [x] search installed npm packages for plugins
- [ ] store CommonJS modules for views in `views/lib/*`
- [ ] reroot CommonJS into the design documents instead of storing everything in `commonjs/*`

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