Professional ES6 Starter Kit
The primary goal of this project is to allow a rapid kick-start of your development process by trying to avoid the tedious task of installing tons of libraries along with the following configurations. Moreover, it helps to maintain a professional workflow during development.
Note: Default assets as the
__test__ folders are to be considered as examples.
What does it include?
- Development / Build tasks
- Webpack 2.0 module bundler
- Babel transpiler
- Code Quality
- Software Release
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 file and, if necessary, clear out the git history of the original repo.
After that, you can start fresh with
semantic-release by invoking the
setup task, like this:
yarn setup or
npm run setup
You may also run dependencies installation manually with:
By default the
src/index.js file acts as a single point of access for the build system.
build directory will contain the
build.min.js files. The former will be a production version of your software that you will ship and the latter will be a development version instead.
Check out the comments inside the
webpack.config.js file If you want to use your library directly into the browser.
yarn dev or
npm run dev
It will open the
index.html page within your favourite browser.
JSDoc allows us to use a markdown file as the home of the API. By default, the system uses the
home_manifest.md file under the
__jsDoc__ directory as template.
To release a new version, you'll need to create a commit with
To generate changelog draft run
npm run changelog:preview or
yarn changelog:preview .
To commit changelog run
npm run changelog:commit or
More info here
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.