Skip to content

rubynz/kiwi-ruby-2017

Repository files navigation

Kiwi Ruby

The website for New Zealand's premier (only) Ruby conference, Kiwi Ruby.

Built with Middleman and also with 💖love💖.

Development

First-time setup

Set up the app:

./bin/setup

Running the app

Spin up Middleman’s development server:

bundle exec rake watch

It should be accessible at http://localhost:4567

Build

To build out all files locally:

bundle exec rake build

Deployment

The website is hosted on GitHub Pages, and deployed using the middleman-deploy gem.

Provided you have write access to this repository, you should be able to deploy with the following command:

middleman deploy

Assets

Assets are built/bundled using webpack and are built into the final static build using Middleman’s external_pipeline feature.

You can install and require npm dependencies throughout your JavaScript and CSS:

npm install --save viewloader
var viewloader = require('viewloader')

The assets work in a similar fashion to our webpack setup in our other app skeleton projects. An asset will be built for each "target" under source/assets/:

source/
|-- assets/
    |-- public/
    |   |-- target.js
    |   |-- index.css*
    |   |-- index.js*
    |-- another-target/
        |-- target.js
        |-- index.js*

Each target must include a target.js file, but doesn’t have to build out both CSS and JavaScript. The structure above would generate:

assets/public.js
assets/public.css
assets/another-target.js