Frizz

Frizz is a utility for deploying static sites to S3. It also comes with some nifty Middleman integrations for managing environments.

Features

Sets Content-Type (including CSS files which S3 is notoriously bad at)
Only uploads files that have changed
Removes files that have been deleted locally

Middleman Features

Free rake tasks for building and deploying your environments
Accessing environment-specific configurations from your views

Installation

Add this line to your application's Gemfile:

gem "frizz"

And then execute:

$ bundle

Or install it yourself as:

$ gem install frizz

Usage

Configuration

AWS

Frizz will automatically look for this in ENV vars: AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY. Or you can optionally configure manually:

Frizz.configure do |config|
  config.access_key_id = ENV["AWS_ACCESS_KEY_ID"]
  config.secret_access_key = ENV["AWS_SECRET_ACCESS_KEY"]
end

Basic deploys

Deploy the contents of build/ to your static website at "my-static-site.com", assuming your S3 bucket is named after your host as S3 static hosting requires:

site = Frizz::Site.new("my-static-site.com")
site.deploy!

Specify a different local build dir:

site = Frizz::Site.new("my-static-site.com", from: "build/public")

Usage With Middleman

Managing more than the basic two environments (dev and build) in a Middleman app can be a pain, which is why Frizz comes with optional Middleman-specific functionality to make things fun again!

`frizz.yml`

Create a frizz.yml in the root of your project. This is how Frizz will know what you want in each of your environments and where you want to deploy them to.

Rake tasks

Based on your frizz.yml, Frizz will create useful Rake tasks for building and deploying.

Configuration

Add it to your Rakefile:

require "frizz/middleman/tasks"

Usage

With the following frizz.yml:

environments:
  staging:
    host: "staging.example.com"
  production:
    host: "example.com"

Frizz would give us the following Rake tasks:

$ rake -T
rake frizz:build:production    # Build production
rake frizz:build:staging       # Build staging
rake frizz:deploy:production   # Deploy build dir to production: example.com
rake frizz:deploy:staging      # Deploy build dir to staging: staging.example.com
rake frizz:release:production  # Build and deploy production: example.com
rake frizz:release:staging     # Build and deploy staging: staging.example.com

Settings and Variables for each of your environments

Ever built a frontend app and wanted to hit a different API for dev, staging, and production environments? Frizz lets you specify arbitrary environment-specific configurations in frizz.yml and access them later in your Middleman app's views.

Configuration

Active the Extension in your config.rb:

require "frizz/middleman/extension"
activate :frizz

Usage

With the following frizz.yml:

environments:
  staging:
    host: "staging.example.com"
    api_root: http://api.staging.example.com/v0
    welcome_message: I'm A Staging Server
  production:
    host: "example.com"
    api_root: http://api.example.com/v0
    welcome_message: I'm A Production Server
  development:
    api_root: http://localhost:3000/v0
    welcome_message: Developers! Developers! Developers!

You would be able to access your variables from views like so:

<script type="text/javascript">MyApp.config.apiRoot = "<%= frizz.api_root %>";</script>
<h1><%= frizz.welcome_message %></h1>
<h2><%= "And hi QA team!" if frizz.staging? %></h2>

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request