# @hoodie/account-server

> Account JSON API backed by PouchDB

Latest version **6.1.5** (published 2017-12-20) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @hoodie/account-server
pnpm add @hoodie/account-server
yarn add @hoodie/account-server
bun add @hoodie/account-server
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 6.1.5 |
| Published | 2017-12-20 |
| First published | 2016-03-25 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 12 |
| Known vulnerabilities | 0 (+19 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 21 |
| Author | The Hoodie Community and other contributors \| http://hood.ie/ |
| Maintainers | hoodie |
| Keywords | hapi, plugin, couchdb, account, hoodie |

## Links

- npm: https://www.npmjs.com/package/@hoodie/account-server
- Repository: https://github.com/hoodiehq/hoodie-account-server
- Homepage: https://github.com/hoodiehq/hoodie-account-server#readme
- Issues: https://github.com/hoodiehq/hoodie-account-server/issues
- npm.io page: https://npm.io/package/@hoodie/account-server

## Dependencies (12)

- [joi](https://npm.io/package/joi.md) ^10.0.0
- [boom](https://npm.io/package/boom.md) ^5.0.0
- [uuid](https://npm.io/package/uuid.md) ^3.0.0
- [lodash](https://npm.io/package/lodash.md) ^4.0.1
- [base64url](https://npm.io/package/base64url.md) ^2.0.0
- [nodemailer](https://npm.io/package/nodemailer.md) ^2.0.0
- [randomstring](https://npm.io/package/randomstring.md) ^1.1.3
- [pouchdb-admins](https://npm.io/package/pouchdb-admins.md) ^1.0.2
- [pouchdb-errors](https://npm.io/package/pouchdb-errors.md) 6.4.1
- [@gar/hapi-json-api](https://npm.io/package/@gar/hapi-json-api.md) 2.0.3
- [@hoodie/account-server-api](https://npm.io/package/@hoodie/account-server-api.md) ^3.8.2
- [couchdb-calculate-session-id](https://npm.io/package/couchdb-calculate-session-id.md) ^1.1.0

## Recent versions

- 6.1.5 (latest) — 2017-12-20
- 6.1.4 — 2017-10-21
- 6.1.3 — 2017-07-15
- 6.1.2 — 2017-06-13
- 6.1.1 — 2017-06-11
- 6.1.0 — 2017-01-25
- 6.0.6 — 2016-11-18
- 6.0.5 — 2016-11-18
- 6.0.4 — 2016-10-24
- 6.0.3 — 2016-10-23
- 6.0.2 — 2016-10-22
- 6.0.1 — 2016-10-22
- 6.0.0 — 2016-10-22
- 5.1.3 — 2016-10-22
- 5.1.2 — 2016-10-21
- … 21 more at https://npm.io/package/@hoodie/account-server/versions

## README

# hoodie-account-server

> Account JSON API backed by PouchDB

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

`hoodie-account-server` is a [Hapi](http://hapijs.com/) plugin that implements
the [Account JSON API](http://docs.accountjsonapi.apiary.io) routes and exposes
a corresponding API at `server.plugins.account.api.*`, persisting user accounts
using [PouchDB](https://pouchdb.com).

## Example

```js
var Hapi = require('hapi')
var PouchDB = require('PouchDB')
var hapiAccount = require('@hoodie/account-server')

var options = {
  PouchDB: PouchDB,
  admins: {
    admin: '-pbkdf2-a2ca9d3ee921c26d2e9d61e03a0801b11b8725c6,1081b31861bd1e91611341da16c11c16a12c13718d1f712e,10'
  },
  secret: 'secret123'
})

server.register({register: hapiAccount, options: options}, function (error) {})
server.connection({ port: 8000 })
server.start(function () {
  console.log('Server running at %s', server.info.uri)
})
```

## More

- [Plugin & Options](plugin/README.md)
- [Routes](routes/README.md)
- [How it works](how-it-works.md)
- [Testing](tests/README.md)

## 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)

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