grunt-webapps

Create workflow for building single webpage products.

Getting Started

This plugin requires Grunt ~0.4.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-webapps --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-webapps');

The "webapps" task

Overview

In your project's Gruntfile, add a section named webapps to the data object passed into grunt.initConfig().

grunt.initConfig({
  webapps: {
    app: {
      options: {
        // Task-specific options go here.
      },
    }
  },
})

This will setup various task for you to development of your single page web apps. The workflow requires you to have your main application in app folder and client modifications in clients folder.

Usage

To start development on local server on port 9000 just run

grunt server

To build the project for deployment run

grunt build

and then to test if build is correct run local server as in

grunt server:dist

Finally, to deploy run

grunt deploy: --client= --user=

You can skip client/user flags if defaults are good. By default staging environment is used so if you are all lazy(like me) run:

grunt deploy --client=

Options

options.root

Type: String Default value: ', '

The root value is used to determine the root directory from which all tasks are executed.

options.client

Type: String

The client will determine the default client to use when building the assets.

options.punctuation

Type: String Default value: '.'

A string value that is used to do something else with whatever else.

Usage Examples

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)