Project template for gulp.js
- Jade files to HTML
- Stylus files to CSS
- ES6+ JavaScript files to ES5 Javascript through browserify
- You are able to use
import
in your client-side code
- You are able to use
- Uses BrowserSync to serve your static files to localhost:9001 and to automatically reload your browser when files change.
- Install Node.js
git clone git@github.com:leonidas/gulp-project-template.git <your project name>
cd <your project name>
npm install
npm start
open http://localhost:9001 in your browser
- npm install
- Installs server-side dependencies from npm
- npm start
- Compiles your files, starts watching files for changes, serves static files to port 9001
- npm run build
- Builds everything
Minification, uglification and other tasks you're expected to run before deploying your product can be made by running the build command with env variable NODE_ENV set to "production"
NODE_ENV=production npm run build
public - directory should be dedicated only to compiled/copied files from src - directory. It should be possible to delete directory completely and after npm start or npm run build everything should be as they were before the deletion.
All dependencies are meant to be installed with npm.
- JavaScript-files from node_modules can be require()'d in client-side modules.
- CSS files can be imported from node_modules using relative path from the stylus file to the css file e.g
@import '../../node_modules/bootstrap/dist/css/bootstrap.css'
- You can either create a new gulp task for copying other assets from directories mentioned above or use an array as a value for assets sources e.g
source: ['./src/assets/**/*.*', 'node_modules/bootstrap/fonts*/*.*']
(notice the asterisk after 'fonts'? It makes gulp copy the whole directory instead of just the files inside of it)
- eslint
- When used as an editor plugin (for example. SublimeLinter + SublimeLinter-eslint), gives you immediate feedback about your code and can find bugs, potential problem areas, poor coding styles and stylistic issues.
Check out the coffee branch