brandaris

System Preparation

Required tools

When updating from <3.0.0, see section below.

To use the front end develop environment for the projects, you'll need the following things installed on your machine.

1. NodeJS - use the installer.
2. Ruby - use an installer like RubyInstaller.
3. Jekyll - $ gem install jekyll:3.7.2 jekyll-sitemap:1.2.0 kramdown:1.16.2 rouge:3.1.1 (use gem cleanup for removing older versions)

Updating from < 3.0.0

Start clean, remove old dependencies before installing the required tools.

Update npm

Run as administrator.

$ npm install -g npm

Remove old modules:

$ rm -rf node_modules
$ gem cleanup jekyll jekyll-sitemap kramdown rouge

Recommended tools

• Atom

  Atom is a fast, goodlooking and extendable text editor by GitHub.

• Cmdr

  Console emulator for Windows, based on Conemu. For context menu integration open terminal in installation dir (preferably C:\cmder) as Administrator and run .\cmder.exe /REGISTER ALL.

  Mini (download) version should be enough.

Local Installation

After installing required tools, run the following command inside the brandaris directory:

$ npm install

Usage

For running development enviroment with Hot Module Replacement (HMR) and Browsersync, run the following command:

$ npm run start

Building production

The production build contains minified CSS and JavaScript. For building production run:

$ npm run build

Configuration files

By default there are development/production settings for Jekyll and Webpack.

License

Copyright (c) 2016 Maarten Brakkee

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.