# @release-notes/hub

> A hub for hosting release notes.

Latest version **0.5.0** (published 2018-02-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @release-notes/hub
pnpm add @release-notes/hub
yarn add @release-notes/hub
bun add @release-notes/hub
```

## 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.5.0 |
| Published | 2018-02-19 |
| First published | 2017-09-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 29 |
| Unpacked size | 404.4 KB |
| Known vulnerabilities | 0 (+23 in 7 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Alrik Zachert |
| Maintainers | a-z |
| Keywords | release notes, release-notes, releasenotes, release, notes, changelog |

## Links

- npm: https://www.npmjs.com/package/@release-notes/hub
- Repository: https://github.com/release-notes/release-notes-hub
- Homepage: https://github.com/release-notes/release-notes-hub#readme
- Issues: https://github.com/release-notes/release-notes-hub/issues
- npm.io page: https://npm.io/package/@release-notes/hub

## Dependencies (29)

- [pug](https://npm.io/package/pug.md) ^2.0.0-rc.4
- [async](https://npm.io/package/async.md) ^2.6.0
- [kermit](https://npm.io/package/kermit.md) ^2.2.0
- [marked](https://npm.io/package/marked.md) ^0.3.15
- [moment](https://npm.io/package/moment.md) ^2.20.1
- [multer](https://npm.io/package/multer.md) ^1.3.0
- [express](https://npm.io/package/express.md) ^4.16.2
- [mdi-svg](https://npm.io/package/mdi-svg.md) ^2.1.19
- [bcryptjs](https://npm.io/package/bcryptjs.md) ^2.4.3
- [mongoose](https://npm.io/package/mongoose.md) ^5.0.6
- [passport](https://npm.io/package/passport.md) ^0.4.0
- [sparkpost](https://npm.io/package/sparkpost.md) ^2.1.2
- [body-parser](https://npm.io/package/body-parser.md) ^1.18.2
- [highlight.js](https://npm.io/package/highlight.js.md) ^9.12.0
- [bunyan-format](https://npm.io/package/bunyan-format.md) ~0.2.1
- [cookie-parser](https://npm.io/package/cookie-parser.md) ^1.4.3
- [kermit-bunyan](https://npm.io/package/kermit-bunyan.md) ~0.1.0
- [passport-local](https://npm.io/package/passport-local.md) ^1.0.0
- [express-openapi](https://npm.io/package/express-openapi.md) ^1.4.0
- [express-session](https://npm.io/package/express-session.md) ^1.15.6
- [kermit-mongoose](https://npm.io/package/kermit-mongoose.md) ^0.3.0
- [swagger-ui-dist](https://npm.io/package/swagger-ui-dist.md) ^3.10.0
- [passport-github2](https://npm.io/package/passport-github2.md) ^0.1.11
- [express-validator](https://npm.io/package/express-validator.md) ^5.0.1
- [mongoose-paginate](https://npm.io/package/mongoose-paginate.md) ^5.0.3
- [@release-notes/node](https://npm.io/package/@release-notes/node.md) ^0.3.0
- [kermit-service-observer](https://npm.io/package/kermit-service-observer.md) ~0.1.1
- [passport-google-oauth20](https://npm.io/package/passport-google-oauth20.md) ^1.0.0
- [@release-notes/changelog-parser](https://npm.io/package/@release-notes/changelog-parser.md) ^0.1.2

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 0.5.0 (latest) — 2018-02-19
- 0.4.0 — 2017-12-14
- 0.3.0 — 2017-09-29
- 0.2.0 — 2017-09-12
- 0.1.0 — 2017-09-04

## README

# Release Notes Hub

[![Subscribe to Release Notes](https://release-notes.com/badges/v1.svg)](https://release-notes.com/@release-notes/release-notes-hub)

## Installation

The recommended way of hacking the release notes hub is by using the
docker compose based [dev env][ReleaseNotesHubDevEnv].
Run the dev env installation and setup steps.

This will launch the hub on localhost:8080.

## Environment Variables

The app is aware of the following environment variables:

| Variable | Description | Default |
|----------|-------------|---------|
| PORT | The http port the express server will listen to. | 8080 |
| MONGODB_HOST | Hostname of the mongodb backend | 'release-notes-mongo' |
| MONGODB_PORT | Port of the mongodb backend | 27017 |
| MONGODB_USER | Mongodb user | _empty_ |
| MONGODB_PASSWORD | Passoword of the mongodb user | _empty_ |
| MONGODB_DATABASE | The db to use | 'release-notes' |
| SPARK_POST_API_KEY | Api key for sending transactional email | _empty_ |
| EMAIL_DEFAULT_REPLY_TO | Default reply-to email address | 'Release Notes <hello@release-notes.com>' |
| GITHUB_CLIENT_ID | The github client id | _empty_ |
| GITHUB_CLIENT_SECRET | The github client secret | _empty_ |
| GOOGLE_CLIENT_ID | The google client id | _empty_ |
| GOOGLE_CLIENT_SECRET | The google client secret | _empty_ |
| PIWIK_ENABLED | Whether piwik tracking is enabled | true |
| PIWIK_SITE_ID | The related piwik site id | 1 |

[ReleaseNotesHubDevEnv]: https://github.com/release-notes/release-notes-hub-dev-env

---

### LICENSE

The files in this archive are released under MIT license.
You can find a copy of this license in [LICENSE](LICENSE).

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