This bash script takes the headache that is setting up a JS project with npm/gulp/etc..etc.. and automates that process. It keeps you informed on exactly what it is doing when it's doing via terminal messages.
After the script is done generating the boilerplate project, it will run gulp jshint to make sure there are no syntactical errors. Then it will run gulp build --prod to make sure all gulp tasks are working properly. Finally it will run npm test just to verify that karma-jasmine was setup correctly.
First, clone this repo:
$ git clone https://github.com/AbdulYahya/gulp-boilerplate-gen.gitFrom your terminal, cd into the directory you just cloned:
🚸 Path below is just an example an likely doesn't exist, unless of course you cloned into you desktop.
$ cd ~/Desktop/js-gulp-genBefore generating your project, you will need to decide on whether or not you would like to use a CSS framework. And if so, which one? You have a few different options to choose from:
🔔 Note, whatever you decide on generating, your project will be Fully functional (NPM/Gulp/Karma-Jasmine)
Commands denoted by 🚧 are currently not available, but will be in the very near future.
| Generation Commands | Framework | Description |
|---|---|---|
🚧 $ ./generate 🚧 |
Barebones | No CSS what so ever |
$ ./generate -f bootstrap |
Bootstrap | The latest v4.x release of Bootstrap |
🚧 $ ./generate -f materialize 🚧 |
Materialize | The latest v0.xx.x release of Materialize |
$ ./generate -f tailwind |
Tailwind | The latest v0.x.x release of Tailwind |
‼️ $ npm test does not work right off the bat, you have to make the following edit to your package.json.
Change the default test script:
...
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},With karma's test script command:
...
"scripts": {
"test": "karma start karma.conf.js"
},Now test it by running:
npm testPermission 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.