About
----Browser Matrix
----Mobile Matrix
----Technologies Used
----Architecture
Getting Started
----Prerequisites
----Setup
Development
----Branches
----Launch Development Mode
----Releasing Code

This is a boilerplate for building ES6 based projects. Its is very barebones with no frameworks or libraries.

Here is a list of the frameworks, libraries and tools used to build this project:

• Browserify
• Babel
• SASS v1.0 (link)
• Grunt v1.0 (link)
• vccp-dev

Here is an overview of the project architecture:

Folder structure:

src/ <!-- Development source code-->
  |- js/ <!-- components and main files -->
    |- component/ <!-- component folder -->
      |- style/ <!-- component style files -->
  |- lib/ <!-- third-party library files -->
  |- resource/ <!-- resources for the app such as images and fonts -->
    |- image/ <!-- images -->
    |- font/ <!-- fonts -->
dist/ <!-- Compiled code-->
test/ <!-- Test scripts -->
util/ <!-- for CLI -->
  |- task/ <!-- modules for a task runner such as grunt -->
  |- server/ <!-- node local server files -->

You are going to need:

• Node (link)
• Grunt-CLI (link)
• vccp-dev

This project has been built and tested on the following machines/systems:

• Windows 10
• Mac

1. clone repo
2. open cmd
3. cd into project folder
4. Run the following:

npm install  

Always create a branch from develop.

To create a feature branch, follow the naming convention below:

sprint-1/feature/feature-name

To create a bug-fix branch, follow the naming convention below:

sprint-1/bug-fix/bug-name

Run the following command to start developing and to stage the development environment

grunt

Please ensure all code is linted via the following command otherwise you cannot merge code to develop.

vccp-dev lint

You should only use the following command when merging to the develop branch.

vccp-dev merge-to-develop

To release your code, use the following command:

vccp-dev release --prod --keep

###Flags

Please read the documentation for vccp-dev.