alpineio/quixote

Alpine.IO Theme Builder

0.1.3 2016-04-28 17:11 UTC

Requires

• alpineio/rocinante: ^0.1

Requires (Dev)

• phpunit/phpunit: ^5.1

MIT

• Morgan O'Neal

README

Installing a new theme requires Composer

Setup new theme

1. composer create-project alpineio/quixote theme-name creates a new copy of the Quixote composer project with base boilerplate.
2. cd theme-name
3. vendor/bin/rocinante theme:regen "Super Awesome Theme" ./ renames Alpine.IO's base Underscores theme in the current directory.

Compiling CSS and JavaScript

Bootstrap uses gulp with convenient methods for working with the framework. It's how we compile our code, run tests, and more. To use it, install the required dependencies as directed and then run some gulp commands.

Install Gulp

From the command line:

1. Install gulp-cli globally with npm install -g gulp-cli.
2. Navigate to the root, then run npm install. npm will look at package.json and automatically install the necessary local dependencies listed there.

When completed, you'll be able to run the various gulp commands provided from the command line.

Unfamiliar with npm? Don't have node installed? That's a-okay. npm stands for node packaged modules and is a way to manage development dependencies through node.js. Download and install node.js before proceeding.

Available gulp commands

Build - gulp

Run gulp to compile static assets and local web server for theme preview. CSS, Images and JavaScript compile into /assets. Uses Sass and UglifyJS.

Only compile CSS and JavaScript - gulp assets

gulp assets creates the /assets directory with compiled files. Uses Sass and UglifyJS.

Only compile CSS - gulp styles

gulp styles creates the /assets/css directory with compiled css. Uses Sass and Autoprefixer.

Only compile JavaScript - gulp scripts

gulp scripts creates the /assets/js directory with compiled javascript. Uses UglifyJS.

Only compile Image - gulp images

gulp images creates the /assets/images directory with compiled images. Uses Imagemin.

Watch - gulp watch

This is a convenience method for watching images, javascript, sass and font files, automatically building them whenever you save.

Docker Components

Quixote ships with a few docker containers to help preview and test your theme

To start docker run the below docker command

• Start docker docker-compose up

Local Docker

You may install a local Docker machine from something like: https://www.docker.com/products/docker-toolbox

WordPress

http://192.168.99.100:3001/

phpMyAdmin

http://192.168.99.100:3100/ username: root password: secret