# @andersnormal/fluffy

> A teeny tiny server side renderer middleware for Vue.js

Latest version **1.2.2** (published 2018-07-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install @andersnormal/fluffy
pnpm add @andersnormal/fluffy
yarn add @andersnormal/fluffy
bun add @andersnormal/fluffy
```

Provides the command `fluffy`.

## 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 | 1.2.2 |
| Published | 2018-07-02 |
| First published | 2018-06-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=9.11.2 |
| Dependencies | 14 |
| Unpacked size | 41.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Sebastian Döll |
| Maintainers | katallaxie |

## Links

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

## Dependencies (14)

- [koa](https://npm.io/package/koa.md) ^2.5.1
- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [tslib](https://npm.io/package/tslib.md) ^1.9.3
- [yargs](https://npm.io/package/yargs.md) ^11.0.0
- [assert](https://npm.io/package/assert.md) ^1.4.1
- [ts-node](https://npm.io/package/ts-node.md) ^7.0.0
- [webpack](https://npm.io/package/webpack.md) ^4.14.0
- [lru-cache](https://npm.io/package/lru-cache.md) ^4.1.3
- [memory-fs](https://npm.io/package/memory-fs.md) ^0.4.1
- [koa-router](https://npm.io/package/koa-router.md) ^7.4.0
- [typescript](https://npm.io/package/typescript.md) ^2.9.2
- [koa-webpack](https://npm.io/package/koa-webpack.md) ^5.0.2
- [vue-server-renderer](https://npm.io/package/vue-server-renderer.md) ^2.5.16
- [http-graceful-shutdown](https://npm.io/package/http-graceful-shutdown.md) ^2.1.1

## Recent versions

- 1.2.2 (latest) — 2018-07-02
- 1.2.1 — 2018-07-02
- 1.2.0 — 2018-07-02
- 1.0.1-21 — 2018-07-01
- 1.0.1-20 — 2018-07-01
- 1.0.1-19 — 2018-07-01
- 1.0.1-18 — 2018-07-01
- 1.0.1-17 — 2018-07-01
- 1.0.1-16 — 2018-07-01
- 1.0.1-15 — 2018-07-01
- 1.0.1-14 — 2018-07-01
- 1.0.1-13 — 2018-07-01
- 1.0.1-12 — 2018-07-01
- 1.0.1-11 — 2018-06-30
- 1.0.1-10 — 2018-06-30
- … 9 more at https://npm.io/package/@andersnormal/fluffy/versions

## README

# :dragon_face: Fluffy

<br/>

[![Build Status](https://travis-ci.org/andersnormal/fluffy.svg?branch=master)](https://travis-ci.org/andersnormal/fluffy.svg?branch=master)
[![Taylor Swift](https://img.shields.io/badge/secured%20by-taylor%20swift-brightgreen.svg)](https://twitter.com/SwiftOnSecurity)
[![Volkswagen](https://auchenberg.github.io/volkswagen/volkswargen_ci.svg?v=1)](https://github.com/auchenberg/volkswagen)
[![TypeScript](https://badges.frapsoft.com/typescript/awesome/typescript.png?v=101)](https://github.com/ellerbrock/typescript-badges/)
[![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)

Fluffy is a **server side renderer** middleware for [Vue.js](https://vuejs.org/), which is intended to be used with [Nginx](https://nginx.org) to proxy requests.

## Getting Started

> requires a `node` version >= 9.11.2 and an `npm` version >= 5.x.x
> Fluffy uses [Koa](https://github.com/koajs/koa) as middleware
> Fluffy provides a `help` command to display all possible arguments

:scream_cat: [vue-preboot](https://github.com/katallaxie/vue-preboot) is using Fluffy for development and delivery. Check it out.

```bash
# Installs Fluffy to your Vue
npm i @andersnormal/fluffy

# Start fluffy
./node_modules/.bin/fluffy -port 3000 --dev --webpack config/configs --bundle public/vue-ssr-server-bundle.json --manifest public/vue-ssr-client-manifest.json --template public/index.html
```

## Arguments

> most command line arguments have a reflection in environment variables, which allows it to be easily tested and developed in many environments

### `help`

Displays all the available arguments

### `--socket` (string) Default: `/tmp/fluffy.sock`

The socket to listen on for rendering requests.

### `--dev` (boolean)

Enable the [koa-webpack](https://github.com/shellscape/koa-webpack) middleware for development.

### `--webpack` (string)

Path to the Webpack config for development. This should expose an object with

```
{
  ssrConfig: YOUR_CONFIG,
  devConfig: YOUR_CONFIG
}
```

### `--port` (number)

The port to listen on for rendering requests.

### `--bundle` (string)

Path to the server bundle.

### `--manifest` (string)

Path to the client manifest

### `--template` (string)

Path to the render template.

### `--mode` (string)

The Unix socket file system [mode](https://en.wikipedia.org/wiki/File_system_permissions).

### `--version`

Displays the current version of :dragon_face: Fluffy

## Development

> all commands can be seen via `npm run help`

```bash
# Clone the repository
git clone https://github.com/andersnormal/fluffy

# Start the local dev server
docker-compose up
```

Have fun!

## License
[MIT](/LICENSE)

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