https://github.com/billiebobbel23/node-boilerplate
A NodeJS boilerplate for building, watching, linting and testing various front-end assets.
https://github.com/billiebobbel23/node-boilerplate
gulp gulp-starter gulp-tasks gulpjs jasmine node-boilerplate nodejs webpack
Last synced: 2 months ago
JSON representation
A NodeJS boilerplate for building, watching, linting and testing various front-end assets.
- Host: GitHub
- URL: https://github.com/billiebobbel23/node-boilerplate
- Owner: BillieBobbel23
- Created: 2018-03-04T18:10:28.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T09:37:28.000Z (over 2 years ago)
- Last Synced: 2024-07-30T18:57:09.556Z (10 months ago)
- Topics: gulp, gulp-starter, gulp-tasks, gulpjs, jasmine, node-boilerplate, nodejs, webpack
- Language: JavaScript
- Homepage:
- Size: 2.72 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# node-boilerplate
A NodeJS boilerplate for building, watching, linting and testing various front-end assets.
Using GulpJS, Webpack and Jasmine.
## Installation:
```
git clone https://github.com/BillieBobbel23/node-boilerplate tools &&
npm --prefix ./tools install ./tools
```
**Windows:**
```
git clone https://github.com/BillieBobbel23/node-boilerplate tools
cd tools
npm install
```
## Usage:
### Running scripts
**Directly:**
In your CLI go to the `./tools` directory and run `npm run TASK_NAME`.
Alternatively run it from the root folder by using a prefix ``npm run TASK_NAME --prefix ./tools``
**Automated**
Add a reference to any task to your ``package.json`` to extend existing functionality
````
"scripts": {
"build": "npm run build --prefix ./tools"
},
````
### Scripts
* ``npm run build`` : Builds all Front-end assets to the output folder
* ``npm run watch`` : Starts streams for GulpJS and Webpack **Opens a new window**
* ``npm run lint`` : Lints output HTML, CSS and JS
* ``npm test`` : Runs tests on JS using Jasmine
and two subtasks:
* ``npm run clean`` : Removes output folder
* ``npm run rebuild`` : Runs *clean* followed by *build*
### Debugging
Clones [test-assets](https://github.com/BillieBobbel23/test-assets) into tools/debug to run the tasks against
* ``npm run debug:init`` : Runs all tasks on the debug package and output results
* ``npm run debug`` : Runs all tasks on the debug package and output results