Git Product home page Git Product logo

ideas's Introduction

Project template for gulp.js

Codeship Status for leonidas/gulp-project-template

What it does

  • Jade files to HTML
  • Stylus files to CSS
  • ES6+ JavaScript files to ES5 Javascript through browserify
    • You are able to use 'require' in your client-side code
  • Uses BrowserSync to serves your static files to localhost:9001 and to automatically reload your browser when files change.

Getting things up and running

 git clone [email protected]:leonidas/gulp-project-template.git <your project name>
 cd <your project name>
 npm install
 npm start
 open http://localhost:9001 in your browser

CLI Commands

  • npm install
    • Installs server-side dependencies from NPM and client-side dependencies from Bower
  • npm start
    • Compiles your files, starts watching files for changes, serves static files to port 9001
  • npm run build
    • Builds everything

Production build

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

Development guidelines

Directory structure

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.

Dependencies

All dependencies are meant to be installed with bower or with npm.

  • JavaScript-files from both bower_components and node_modules can be require()'d in client-side modules.
  • CSS files can be imported from bower_components and node_modules using relative path from the stylus file to the css file e.g @import '../../bower_components/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/**/*.*', 'bower_components/bootstrap/fonts*/*.*'] (notice the asterisk after 'fonts'? It makes gulp copy the whole directory instead of just the files inside of it)

Suggested development tools

  • 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.

FAQ

I want to use CoffeeScript instead of JavaScript

Check out the coffee branch

ideas's People

Contributors

rikukissa avatar cheapsteak avatar dahlie avatar eetu avatar

Stargazers

Angus H. avatar Mouna Cheikhna avatar André Staltz avatar Denis Stoyanov avatar

Watchers

James Cloos avatar Denis Stoyanov avatar  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.