This repository provides a full development & build workflow for your nextvanilla ES6 Javascriptproject.
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 thesrc
,public
,and__test__
folders are to be considered as examples.
What does it include?
- Development / Build tasks
- Webpack 2.0module bundler
- Babeltranspiler
- 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
- Software Release
git clone https://github /GabrieleRomeo/ES6-Professional-starter-kit.git
cdES6-Professional-starter-kit
Update the project's information inside thepackage.json
file and, if necessary,clear outthe git history of the original repo.
After that, you can start fresh withsemantic-release
by invoking thesetup
task, like this:
Runyarn setup
ornpm run setup
You may also run dependencies installation manually with:
Runyarn
ornpm install
By default thesrc/index.js
file acts as a single point of access for the build system.
Thebuild
directory will contain thebuild.js
andbuild.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 thewebpack.config.js
file If you want to use your library directly into the browser.
Runyarn dev
ornpm run dev
It will open theindex.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 thehome_manifest.md
file under the__jsDoc__
directory as template.
To release a new version, you'll need to create a commit withChangelog
type.
To generate changelog draft runnpm run changelog:preview
oryarn changelog:preview
.
To commit changelog runnpm run changelog:commit
oryarn changelog:commit
.
More infohere
For more information about the available features / commands, please visit thefollowing 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.