open-index/open-npm huggingface dataset:
npm package: @hoodie/start
Description: start your hoodie app
Author: The Hoodie Community
Latest version: 3.0.0

Usage: npm start -- [options...]

 -h, --help           Show this help message
 -v, --version        Show used hoodie version
     --loglevel       One of silly, verbose, http, info, warn, error, or silent (optional) Default: 'warn'

     --path           Project path (optional) Default: process.cwd()

     --port           Port-number to run the Hoodie App on (optional)
     --bind-address   Address that Hoodie binds to (optional) Default: 127.0.0.1
     --www            WWW path (optional) Default: path.join(options.path, 'www')

     --admin-password Password for the admin-dashboard (required on first run)

     --db-port        Port-number to run the PouchDB Server on (optional)
 -m, --in-memory      Start the PouchDB Server in memory (optional) Default: false
     --db-password    Password to use for the PouchDB Server admin user (optional)
     --db-url         If provided does not start PouchDB Server and uses external CouchDB. Has to contain credentials. (optional)
     --data           Data path (optional) Default: path.join(options.path, 'data')

Options can also be specified as environment variables (prefixed with "hoodie_") or inside a ".hoodierc" file (json or ini).
npm package: @hoodie/store
Description: Hoodie Store core module
Author: The Hoodie Community and other contributors | http://hood.ie/
Latest version: 1.0.4

# hoodie-store

> Hoodie Store core module

[![Build Status](https://travis-ci.org/hoodiehq/hoodie-store.svg?branch=master)](https://travis-ci.org/hoodiehq/hoodie-store)
[![Dependency Status](https://david-dm.org/hoodiehq/hoodie-store.svg)](https://david-dm.org/hoodiehq/hoodie-store)
[![devDependency Status](https://david-dm.org/hoodiehq/hoodie-store/dev-status.svg)](https://david-dm.org/hoodiehq/hoodie-store#info=devDependencies)

`hoodie-store` combines [store-client](https://github.com/hoodiehq/hoodie-store-client),
[store-server](https://github.com/hoodiehq/hoodie-store-server) and exposes a
generic store UI.

## Usage

Start the demo server

```
npm start
```

If you want to use the store module as plugin of your [Hapi](http://hapijs.com/)
server, check out [example/index.js](exmaple/index.js) to see how to register
the [store-server](https://github.com/hoodiehq/hoodie-store-server) and how
to bundle and server the [store-client](https://github.com/hoodiehq/hoodie-store-client)

## Testing

Local setup

```
git clone https://github.com/hoodiehq/hoodie-store.git
cd hoodie-store
npm install
```

Run end-to-end tests with selenium

```
npm test
```

## Contributing

Have a look at the Hoodie project's [contribution guidelines](https://github.com/hoodiehq/hoodie/blob/master/CONTRIBUTING.md).
If you want to hang out you can join our [Hoodie Community Chat](http://hood.ie/chat/).

## License

[Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0)
npm package: @hoodie/store-server
Description: CouchDB API for data persistence and offline sync
Author: The Hoodie Community and other contributors | http://hood.ie/
Latest version: 3.0.0

# hoodie-store-server

> CouchDB API for data persistence and offline sync

[![Build Status](https://travis-ci.org/hoodiehq/hoodie-store-server.svg?branch=master)](https://travis-ci.org/hoodiehq/hoodie-store-server)
[![Coverage Status](https://coveralls.io/repos/hoodiehq/hoodie-store-server/badge.svg?branch=master)](https://coveralls.io/github/hoodiehq/hoodie-store-server?branch=master)
[![Dependency Status](https://david-dm.org/hoodiehq/hoodie-store-server.svg)](https://david-dm.org/hoodiehq/hoodie-store-server)
[![devDependency Status](https://david-dm.org/hoodiehq/hoodie-store-server/dev-status.svg)](https://david-dm.org/hoodiehq/hoodie-store-server#info=devDependencies)

`hoodie-store-server` is a [Hapi](http://hapijs.com/) plugin that implements
[CouchDB’s Document API](https://wiki.apache.org/couchdb/HTTP_Document_API)
and exposes a [JavaScript API](api) to manage databases, access and replications.

## Example

```js
var Hapi = require('hapi')
var hoodieStore = require('@hoodie/store-server')
var PouchDB = require('pouchdb')

var server = new Hapi.Server()

server.connection({
  port: 8000
})

server.register({
  register: hoodieStore,
  options: {
    PouchDB: PouchDB
  }
}, function (error) {
  if (error) throw error
})


server.start(function () {
  console.log('Server running at %s', server.info.uri)
})
```

## Options

### options.PouchDB

PouchDB constructor. _Required_

```js
options: {
  PouchDB: require('pouchdb-core').plugin('pouchdb-adapter-leveldb')
}
```

If you want connect to a CouchDB, use the `pouchdb-adapter-http` and set
`options.prefix` to the CouchDB url. All requests will be proxied to CouchDB
directly, the PouchDB constructor is only used for [server.plugins.store.api](api)

```js
options: {
  PouchDB: require('pouchdb-core')
    .plugin('pouchdb-adapter-http')
    .defaults({
      prefix: 'http://localhost:5984',
      auth: {
        username: 'admin',
        password: 'secret'
      }
    })
}
```

### options.hooks

Route lifecycle hooks. _Optional_

```js
options: {
  hooks: {
    onPreResponse: onPreResponseHandler,
    onPreAuth: onPreAuthHandler,
    onPostAuth: onPostAuthHandler,
    onPreHandler: onPreHandlerHandler,
    onPostHandler: onPostHandlerHandler,
    onPreResponse: onPreResponseHandler
  }
}
```

See http://hapijs.com/api#request-lifecycle for more information

## Testing

Local setup

```
git clone https://github.com/hoodiehq/hoodie-store-server.git
cd hoodie-store-server
npm install
```

Run all tests and code style checks

```
npm test
```

## Contributing

Have a look at the Hoodie project's [contribution guidelines](https://github.com/hoodiehq/hoodie/blob/master/CONTRIBUTING.md).
If you want to hang out you can join our [Hoodie Community Chat](http://hood.ie/chat/).

## License

[Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0)
npm package: @hoodie/task-client
Description: client api for asynchronous task queue, using PouchDB for sync
Author: The Hoodie Community and other contributors | http://hood.ie/
Latest version: 1.0.0

# hoodie-task-client

> client api for asynchronous task queue, using PouchDB for sync

[![Build Status](https://travis-ci.org/hoodiehq/hoodie-task-client.svg?branch=master)](https://travis-ci.org/hoodiehq/hoodie-task-client)
[![Coverage Status](https://coveralls.io/repos/hoodiehq/hoodie-task-client/badge.svg?branch=master)](https://coveralls.io/r/hoodiehq/hoodie-task-client?branch=master)
[![Dependency Status](https://david-dm.org/hoodiehq/hoodie-task-client.svg)](https://david-dm.org/hoodiehq/hoodie-task-client)
[![devDependency Status](https://david-dm.org/hoodiehq/hoodie-task-client/dev-status.svg)](https://david-dm.org/hoodiehq/hoodie-task-client#info=devDependencies)

## Example

```js
taskQueue('email').start({
  to: 'john@example.com',
  subject: 'Ohaj there',
  body: 'Hey John,\n\nhow are things?\n\n– Jane'
}).then(function (task) {
  alert('Email "' + task.subject + '" sent')
}).catch(function (error) {
  alert(error)
})
```

## API

```js
var taskQueue = new TaskQueue(userId, options)

mailQueue = taskQueue('mail')
taskQueue.on(eventName, handler)
taskQueue.one(eventName, handler)

mailQueue.start(attributes/*, options */)
mailQueue.abort(id/*, options */)
mailQueue.restart(id/*, options */)
mailQueue.on(eventName, handler)
mailQueue.one(eventName, handler)
```

Events, same for `mailQueue.on / one` and `taskQueue.on / one`

```js
mailQueue.on('start', handleNewTask)
mailQueue.on('success', handleNewTaskSuccess)
mailQueue.on('error', handleNewTaskError)
```

## Testing

Local setup

```
git clone https://github.com/hoodiehq/hoodie-task-client.git
cd hoodie-task-client
npm install
```

Run all tests and code style checks

```
npm test
```

Run all tests on file change

```
npm run test:watch
```

Run specific tests only

```
node tests/specs # run unit tests
node tests/specs/get-api # run .getApi() unit tests
node tests/integration/walkthrough # run walkthrough integration test
# PROTIP™ Pipe output through a [pretty reporter](https://www.npmjs.com/package/tape#pretty-reporters)
```


## License

[Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0)
npm package: @hoodie/task-server
Description: Hapi plugin that exposes an API for managing tasks and routes for task syncing
Author: The Hoodie Community and other contributors | http://hood.ie/
Latest version: 1.1.0

# hoodie-task-server

> Task API

`hoodie-task-server` is a [Hapi](http://hapijs.com/) plugin that exposes an API for managing tasks and defines all [CouchDB endpoint routes](http://docs.couchdb.org/en/2.0.0/http-api.html) that are necessary for replication so that task objects can be synced.

## Example

```js
var Hapi = require('hapi')
var hoodieTask = require('@hoodie/task-server')
var PouchDB = require('pouchdb')

var server = new Hapi.Server()

server.connection({
  port: 8000
})

server.register({
  register: hoodieTask,
  options: {
    PouchDB: PouchDB
  }
}, function (error) {
  if (error) throw error
})


server.start(function () {
  console.log('Server running at %s', server.info.uri)
})
```

## Options

### options.PouchDB

PouchDB constructor. _Required_

```js
options: {
  PouchDB: require('pouchdb-core')
    .plugin(require('pouchdb-adapter-leveldb'))
    .plugin(require('pouchdb-replication'))
    .plugin(require('pouchdb-mapreduce'))
}
```

If you want connect to a CouchDB instance, use the `pouchdb-adapter-http` and set
`options.prefix` to the CouchDB url. All requests will be proxied to CouchDB
directly, the PouchDB constructor is only used for [server.plugins.store.api](api)

```js
options: {
  PouchDB: require('pouchdb-core')
    .plugin(require('pouchdb-adapter-http'))
    .plugin(require('pouchdb-replication'))
    .plugin(require('pouchdb-mapreduce'))
    .defaults({
      prefix: 'http://localhost:5984',
      auth: {
        username: 'admin',
        password: 'secret'
      }
    })
}
```

## Testing

Local setup

```
git clone https://github.com/hoodiehq/hoodie-task-server.git
cd hoodie-task-server
npm install
```

Run all tests and code style checks

```
npm test
```

## Contributing

Have a look at the Hoodie project's [contribution guidelines](https://github.com/hoodiehq/hoodie/blob/master/CONTRIBUTING.md).
If you want to hang out you can join our [Hoodie Community Chat](http://hood.ie/chat/).

## License

[Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0)