Professional ES6 Starter Kit

A complete ES6 Starter Kit with full development & build workflow for your next vanilla Javascript project.

The main goal of this project is to speed up your development process and maintain a professional level workflow.

What does it include?

• Development / Build / Linting tasks
• Webpack 2.0 module bundler
• Babel transpiler
• Code Quality
  • Eslint / Babel-eslint / eslint-config-airbnb
  • Prettier (code formatting)
  • Pre-commit (Requires eslint checks to be passed before commits)
  • Jest (Testing and Code Coverage)
• Documentation
  • JSDoc 3 Javascript documentation
  • Doxdox
• Software Release
  • Semantic-release

Install

git clone https://github.com/GabrieleRomeo/ES6-Professional-starter-kit.git
cd ES6-Professional-starter-kit

Update the project's information inside the package.json

After that, you can start fresh with semantic-release by invoking the setup task, like this:

yarn setup
// or
npm run setp

Otherwise you can run the dependencies installation manually:

yarn
// or
npm install

Run in development mode

yarn dev
// or
npm run dev

Goto http://localhost:8080

Build

The build directory will contain the build.min.js file, the production version that you will ship.

The public directory contains the build.js file, the development version of your software. This file is ignored by git.

Check the comments inside the webpack.config.js file to see how you can configure the output of Webpack.

For more information about the available features / commands, please visit the following webpage

Copyright 2017 © Gabriele Romeo

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.