Giter Club home page Giter Club logo

gulp-starter-1's Introduction

Gulp Starter

A web application starter using Gulp, node-sass, Browserify, Browsersync, Imagemin, Gulp-notify, Jade, and Watchify for super fast builds. Built off of Dan Tello's Gulp Starter which is really rad.

Getting Started

First of all, this project assumes you have Node installed. If you don't, install that first.

If you do have Node installed, navigate to the gulp-starter directory and install your dependencies:

npm install

Then run the project with:

gulp

You don't even have to open your web browser.

Deploy/gh-pages

You can automatically deploy from your master or feature branches by using the gulp deploy task. This will take whatever is currently in the build/ folder and update the gh-pages branch with its contents, with the benefit of not having to swap back and forth between the two. If you run into fast-forwarding issues and need to force push, check the deploy task comment for a fix.

It's not rare to get this error:

Terminal fast-forward push error

This is a fast-forward error. In essence it's saying you need to deploy before you can pull. However, in this instance, we recommend a force-push as your gh-pages branch should not be something you track as a team and should be checked locally before pushing. If you get this error, check the deploy task, line 9 for additional information on how to proceed.

Gulp Tasks

The Gulp tasks are each packaged into their specified functionality with config.js setting global variables across the project like directory locations. If you need more functions that aren't in here consider contributing back.

.editorconfig

This project uses an .editorconfig. This allows us to make sure that things like whitespace changes don't create useless git commits and allows consistency across a larger team of developers. It will apply these changes locally after you close and reload them. You can read about that design choice here.

If you don't have a plugin for your editor of choice, you can download plugins for EditorConfig from the EditorConfig site.

Why is build/ not in the .gitignore?

build/ is not in the .gitignore because it needs to be tracked in order for the gulp deploy function to work. Annoying, but necessary. If you have suggestions that would make working with this easier consider contributing back.

Halp, I'm having issues!

Please feel free to open an issue and tag it with help wanted. I'll try and get back to you lickety-split!

gulp-starter-1's People

Contributors

helenvholmes avatar

Watchers

Travis Smith avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.