gp-boilerplate

4.0.0 • Public • Published

Boilerplate

NPM version Build Status Windows Build status Dependency Status devDependency Status

This boilerplate structure including tasks and servers should help you to develop modular websites + documentation per partial.

Recommended IDE

Please use Atom.io to develop your project. I tested some other IDEs (IntelliJ, Netbeans, Eclipse, Sublime, ...) but no one offers working support for handlebars and postcss.

Recommended atom.io packages

Following atom.io-packages are recommended to use:

Boilerplate specs

The boilerplate based on gulp and assemble (beta-5).

Implemented tasks

Those tasks are configured by default:

  • clean
  • copy
  • handlebars-compiler
  • postcss-compiler
  • purecss-generator
  • sitemap-generator
  • watch-handler
  • webpack-bundler

They could be modified by env/tasks.json.

Implemented servers

Those servers are configured by default:

  • hapijs
  • hapijs-webpack-dev-server
  • livereload
  • weinre

They could be modified by env/local.json.

Setup your environment

At first install the latest stable node.js version (>=5.1.0) by homebrew.

brew install node

When nodejs is installed you can run

npm install

The installation process should run without some errors.

Test the environment

To verify a working environment just run the following command in the root folder of your project.

npm test

It should build all sources into the 'build'-directory of your project root folder. No error message should be shown in your console.

Run development-environment

npm run dev

Run production-environment

npm run prod

Build production-environment

npm run build

Deployment to heroku

Configuration

Modernizr

modernizr-build can be customized by .modernizrrc inside the root directory of your project. Here you will find all available configuration options.

jshint

ToDo:

  • Check CSSNano - doesn't remove comments
  • Doc Helper
  • Related Links to included partials
  • Sample Controller/Model/Target, Handlebars, CSS
  • Share atom.io configuration
  • implement working Weinre

install node and npm on osx by homebrew https://gist.github.com/DanHerbert/9520689

fixing network problem short version (cmd): npm config set registry http://registry.npmjs.org/ long version: https://github.com/npm/npm/issues/7945

heroku


to install dev dependencies heroku config:set NPM_CONFIG_PRODUCTION=false

Readme

Keywords

Package Sidebar

Install

npm i gp-boilerplate

Weekly Downloads

1

Version

4.0.0

License

GNU GPLv3

Unpacked Size

3.1 MB

Total Files

210

Last publish

Collaborators

  • gp-dev