BASIC WEBAPP BOILERPLATE

This repo contains a small and simplified boilerplate as alternative of other "fat" boilerplates, (automated with grunt) to start a project with angular and bootstrap in order to make easier and faster the template's developing.

Developed following the best practice for Angular.js (John Papa angular-styleguide)

What this boilerplate contains

• [x] Angular framework (1.x)
• [x] Grunt automations
• [x] Javascript linter
• [x] Bootstrap html linter
• [x] Sass / Scss compiler
• [x] Images, Js and Css optimization
• [x] Karma / Jasmine test
• [x] Yarn and Bower package managers
• [x] ES6 supported

Set up

Before cloning the repo be sure you have installed:

• Node (version >= 8.x.x)
• Yarn (version >= 1.2.x)
• Npm (version >= 5.5.x)
• Grunt (latest version)
• Bower (latest version)
• Karma (version >= 1.3.x)

Then:

• Choose a folder project in your system and switch in cd [folder path]
• Clone the repo in your folder git clone https://github.com/ibbatta/grunt-frontend-boilerplate.git

Installation

From the directory of the project run yarn (or npm install);

Usage

Once everything is installed, use Grunt or Yarn from the terminal to start the build tasks.
The package.json exposes these tasks:

• yarn start or npm start (start the project locally)
• yarn test or npm run test (start test and watch for changes)
• yarn build or npm run build (prepare the build pack)
• yarn clean or npm run clean (remove bower components and node modules)

The Gruntfile.js exposes these tasks:

• grunt clean (clean / remove tmp, dist and bower's component folders)

Todo

• [x] Code optimization (maybe ES6 restyle?)
• [ ] Create and link a simple backend (node + express) (???)
• [ ] Create and link a database (maybe firebase?) (???)
• [ ] Try to create a simply blog (i.e. wordpress) (???)
• [ ] Create Yeoman generator (???)

Contributing

• Fork it!
• Create your feature branch: git checkout -b my-new-feature
• Commit your changes: git commit -am 'Add some feature'
• Push to the branch: git push origin my-new-feature
• Submit a pull request

Credits

• Maurizio Battaghini (template develop)
• Aristeidis Bampakos (tests integration and inspiration)

Troubleshootings

This is just a personal boilerplate create for demonstration purpose only, it may or may not be a good fit for your project(s).

GitHub @ibbatta  ·  Twitter @battago