Foreman 0.1.5

Foreman is a small dev assistant that provides tools to make working with Konstruct painless and quick. You can access documentation, build a new project structure and scaffold a new site with simple to use commands.

Key Features

• Set up a new project structure in seconds.
• Scaffold out a new HTML, Jekyll or Angular site in seconds.
• Develop with SASS, Browserify (CommonJS), BrowserSync, Jekyll.
• Build process to optimise assets for deployment.

Installation

You can install Foreman with:

$ npm install -g foreman

Global dependencies

There are number of global dependencies that you will need in order to use Foreman. Below is a list of them:

• chokidar-cli
• browserify
• watchify
• node-sass
• postcss-cli
• cssnano
• autoprefixer
• browser-sync
• uglifyjs
• parallelshell

Platform compatibility

This version of Foreman has only been tested on a mac, but it should work out of the box for Linux too.

I am fairly sure this won't work on Windows. Please log issues when you run into problems and I will fix them asap.

Commands

The Cli has a few very simple commands. If you get stuck simply $ foreman --help for help. You can also get instructions for every command with $ foreman [COMMAND] --help

Foreman Commands

• $ foreman folders
• $ foreman create
• $ foreman refresh
• $ foreman watch
• $ foreman build

Folders

$ foreman folders

Scaffolds a set of project folders to help you organise your project better.

Create

$ foreman create

Creates a new Konstruct starter project through an interactive wizard.

Refresh

$ foreman refresh

Refreshes the project by installing dependencies again. Useful if you inherit a repo from another developer in your team.

Watch

$ foreman watch

Runs the global Gulp tools from your current working directory.

Build

$ foreman build [options]

Runs build scripts & optimisations on your codebase.

Currently optimising:

• Minify JS
• Minify CSS
• Optimise images

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/konstruct/konstruct.cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.