# @webstronauts/mercury

> An opinionated framework built on top of Express.

Latest version **0.10.0** (published 2018-09-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install @webstronauts/mercury
pnpm add @webstronauts/mercury
yarn add @webstronauts/mercury
bun add @webstronauts/mercury
```

Provides the command `mercury`.

## 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.10.0 |
| Published | 2018-09-28 |
| First published | 2018-01-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.9.0 |
| Dependencies | 16 |
| Unpacked size | 9.4 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | Robin van der Vleuten |
| Maintainers | robinvdvleuten |

## Links

- npm: https://www.npmjs.com/package/@webstronauts/mercury
- npm.io page: https://npm.io/package/@webstronauts/mercury

## Dependencies (16)

- [hoek](https://npm.io/package/hoek.md) ^5.0.4
- [meow](https://npm.io/package/meow.md) ^5.0.0
- [pino](https://npm.io/package/pino.md) ^5.0.0
- [pump](https://npm.io/package/pump.md) ^3.0.0
- [avvio](https://npm.io/package/avvio.md) ^5.9.0
- [assert](https://npm.io/package/assert.md) ^1.4.1
- [dotenv](https://npm.io/package/dotenv.md) ^6.0.0
- [express](https://npm.io/package/express.md) ^4.16.3
- [pino-http](https://npm.io/package/pino-http.md) ^4.0.0
- [decamelize](https://npm.io/package/decamelize.md) ^2.0.0
- [http-errors](https://npm.io/package/http-errors.md) ^1.7.1
- [lodash.flow](https://npm.io/package/lodash.flow.md) ^3.5.0
- [lodash.omit](https://npm.io/package/lodash.omit.md) ^4.5.0
- [lodash.pick](https://npm.io/package/lodash.pick.md) ^4.4.0
- [lodash.wrap](https://npm.io/package/lodash.wrap.md) ^4.1.1
- [pino-colada](https://npm.io/package/pino-colada.md) ^1.4.4

## Recent versions

- 0.10.0 (latest) — 2018-09-28
- 0.9.0 — 2018-09-28
- 0.8.0 — 2018-05-30
- 0.7.0 — 2018-05-30
- 0.6.0 — 2018-03-04
- 0.5.0 — 2018-02-22
- 0.4.1 — 2018-02-20
- 0.4.0 — 2018-02-07
- 0.3.0 — 2018-02-07
- 0.2.0 — 2018-02-07
- 0.1.0 — 2018-01-23

## README

<div align="center">

# mercury ⚗️

An opinionated framework built on top of [Express](https://expressjs.com/) and [avvio](https://www.npmjs.com/package/avvio).

<hr />

[![License](https://img.shields.io/github/license/webstronauts/mercury.svg)](LICENSE.md)
[![Version](https://img.shields.io/npm/v/@webstronauts/mercury.svg)](https://www.npmjs.com/package/@webstronauts/mercury)
[![Build Status](https://travis-ci.org/webstronauts/mercury.svg?branch=master)](https://travis-ci.org/webstronauts/mercury)
[![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

</div>

## Installation

This package is distributed via [NPM](https://www.npmjs.com/package/@webstronauts/mercury) which is bundled with [Node](https://nodejs.org/) and should be installed as one of your project's `dependencies`:

```
npm install --save @webstronauts/mercury
```

## Usage

Your application can be as simple as:

```js
// app.js
module.exports = function(app, options, next) {
  app.get('/', function(req, res) {
    res.send({hello: 'world'})
  })

  next()
}
```

If you are using Node 8+, you can use `async` functions too:

```js
// async-await-plugin.js
module.exports = async function(app, options) {
  app.get('/', async function(req, res) {
    res.send({hello: 'world'})
  })
}
```

Then you can start your application with;

```
mercury start plugin.js
```

## Inspiration

We're not re-inventing the wheel here. The inspiration for this framework comes from a couple of other awesome projects;

- https://github.com/mcollina/avvio
- https://github.com/fastify/fastify-cli

## Author(s)

Robin van der Vleuten ([@robinvdvleuten](https://twitter.com/robinvdvleuten)) - [The Webstronauts](https://www.webstronauts.co?utm_source=github&utm_medium=readme&utm_content=mercury)

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