Skip to content

jerkovicl/gulp-starter-kit

Repository files navigation

gulp-starter-kit

Starter kit for Javascript build automation using Gulp & Bower

Build Status devDependency Status

Requirements

  • Install Node (64-bit version)
  • Install Git & GitHub for Windows
    • download here
    • during installation choose option Run Git from the Windows Command Prompt, tutorial here.
    • or choose option Use Git and optional Unix tools from the Windows Command Prompt
      If you choose this option, you'll be able to use the git command from the Windows Command Prompt AS WELL AS all the extra unix tools such as ls, pwd, and ssh-keygen from the Windows Command Prompt.
      Yes, this does replace some Windows-based tools, such as find with the unix version, but unless you're creating python scripts or batch scripts to manage Windows in some fashion, you can get away with this option with little to no issue.
    • download here
    • some tips if you are usign Github Desktop here

Quick Start

Clone this repo and install Gulp & Bower using these commands

syntax: git clone <repo> <directory>

git clone https://github.com/jerkovicl/gulp-starter-kit/  C:\test
npm install gulp -g
npm install bower -g
npm install //install gulp dependencies
bower install //install bower dependencies

Included files

  • .abignore - Exclude Additional Files From Your Application Package (for AppBuilder project)
  • .gitignore - specifies which files/folder should be ignore when doing git commits
  • .gitattributes - gives attributes to pathnames detais
  • .tfignore - specifies which files/folder should be ignored when doing commits for Team Foundation details
  • .npmignore - file to keep stuff out of your package
  • .editorconfig - Define and maintain consistent coding styles between different editors and IDEs.
  • .jscs.json - JS code style checker, used for enforcing coding style only using defined set of rules,
    works in combo with .jshintrc
  • .jscsrc - alternative to .jscs.json file, for case when editor doesn't support json format
  • .jshintrc - set of rules defined for linting JS files (protecting against syntax errors and browser bugs)
  • .jshintignore - exclude some files from linting, usually .min.js files
  • .jlintrc - alternative to .jshintrc file, for use with JSLint in case editor doesn't support JSHint
  • .csslintrc - set of rules defined for linting CSS files using CSSLint, rules here
  • .htmlhintrc - set of rules defined for linting HTML files using HTMLHint, rules here
  • .bowerrc - configuration file for Bower, more info here
  • bower.json - configuration file to define your project's dependencies
  • package.json - file contains meta data about your app or module. Most importantly, it includes the list of dependencies to install from npm when running npm install
  • gulpfile.js - file that tells Gulp it's tasks and what those tasks are and when to run them
  • karma.conf.js - configuration file for Karma Test Runner
  • .travis.yml - configuration file for Travis CI's build environment

All dotfiles can be placed at the root of your project or inside user's HOME directory

Autoformating .js files with JSCS v.1.12.0 -> jscs path/to/script -x

About

Starter Kit for JavaScript Build Automation with Gulp.js

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages