denis-sokolov/frozen-express

# Frozen Express

Frozen Express generates a collection of static files for an Express.js application allowing to host said application easily and cheaply.

Express 4 and Express 3 applications are supported.

[![Build Status](https://travis-ci.org/denis-sokolov/frozen-express.svg?branch=master)](https://travis-ci.org/denis-sokolov/frozen-express)
[![Code Climate](http://img.shields.io/codeclimate/github/denis-sokolov/frozen-express.svg)](https://codeclimate.com/github/denis-sokolov/frozen-express)
[![Coverage Status](https://img.shields.io/coveralls/denis-sokolov/frozen-express.svg)](https://coveralls.io/r/denis-sokolov/frozen-express?branch=master)
[![bitHound Score](https://app.bithound.io/denis-sokolov/frozen-express/badges/score.svg)](http://app.bithound.io/denis-sokolov/frozen-express)
[![Codacy Badge](https://www.codacy.com/project/badge/b0d4b7efff974dbba490fb12861ef11c)](https://www.codacy.com/app/denis-sokolov/frozen-express)
[![Dependency Status](https://gemnasium.com/denis-sokolov/frozen-express.svg)](https://gemnasium.com/denis-sokolov/frozen-express)

## Usage

You can use Frozen Express as a command line tool or access it programatically.

### Command line

Once you install Frozen Express (`npm install -g frozen-express`), you can use it as follows:

```bash
frozen-express app.js dist
```

Here the `app.js` is your module that exports the application, and `dist` is the directory to put the generated files.

Most Frozen Express options are available as command line options, use `frozen-express -h` to see their usage.

### API

```javascript
var frozen = require('frozen-express');

var stream = frozen(app);
```

You can do with the generated `Stream` whatever you want, but the simplest thing is to use `gulp-dest`:

```javascript
var gulp = require('gulp');
var frozen = require('frozen-express');

frozen(app).pipe(gulp.dest('./dist'));
```

You can also include it in your Gulp workflow and perform more tasks with files.

### Options

Frozen Express supports a number of options:

```javascript
var stream = frozen(app, {
    // A list of URLs to freeze
    // By default Frozen will try to detect the URLs itself
    urls: ['/', '/about', '/contact']
});
```