Skip to content

Latest commit

 

History

History
109 lines (85 loc) · 5.18 KB

README.md

File metadata and controls

109 lines (85 loc) · 5.18 KB
Raw

Drupal 7 Gulp Starter Theme

Version: 1.0

Contributors:

Lasse Moos ( @supermoos / yourlocalstudio.dk )

Summary

Drupal 7 Gulp Starter Theme for use as a starting template for building custom themes. Uses SCSS/SASS (with libsass compiler), HTML5 Boilerplate 5 with Modernizr and Normalize.css, and Gulp for all tasks.

Usage

The theme is setup to use Gulp to compile SCSS => CSS, TypeScript => JavaScript (both with source maps), optimize images, and live browser reload using BrowserSync, with flexibility to add any additional tasks via the Gulp-file. Alternatively, you can use CodeKit or whatever else you prefer to compile the SCSS and manage the JavaScript.

What it does:

  • Compile SCSS to CSS from src/scss/style.scss to build/css/style.css and use Autoprefixer so frameworks like Compass and Bourbon can be mostly avoided.
  • Compile TypeScript to JavaScript from src/scrips/ts/main.ts to build/scripts/main.js
  • Minify images and move from src/images/**/* to build/images/**/*
  • Move fonts from src/fonts/**/* to build/fonts/**/*
  • Move vendor JavaScript from src/scripts/vendor/**/* to build/scripts/vendor/**/*
  • Extend with your own tasks...
  • Profit

It does not aggregate, concat, minify or anything else fancy with the compiled CSS / JavaScript files because it is preferred to use the Advanced CSS/JS Aggregation module and Magic for this.

Configuration

Rename folder to your theme name, rename .info file to your theme name, change the src/scss/style.scss intro block to your theme information. Open the theme directory in terminal and run npm install to pull in all Gulp dependencies. Run gulp watch to execute tasks. Code as you will. To optimize images, run gulp imagemin. To build for production run gulp build

To use BrowserSync you will need to change which local development host you want to be proxied through BrowserSync. After running gulp watch your Terminal will output something like this:

[BS] Proxying: http://localhost:8888
[BS] Access URLs:
 --------------------------------------
       Local: http://localhost:3000
    External: http://172.22.33.125:3000
 --------------------------------------
          UI: http://localhost:3001
 UI External: http://172.22.33.125:3001
 --------------------------------------
[BS] Watching files...

The default is not to open a browser window because you might find yourself having 10 http://localhost:3000 tabs open after a while. Instead open one yourself or change the browser-sync task defaults in the gulpfile.js around:

gulp.task('browser-sync', function(){
    //watch files
    var files = [
        'build/css/**/*.css',
        'build/scripts/**/*js',
        'build/images/**/*',
        'templates/*.tpl.php'
    ];

    return browserSync.init(files, {
        proxy: "http://localhost:8888", //change this to whatever your local development URL is.
        open: false,
        injectChanges: true
    });
});

Deployment

TODO

Features

  1. Normalized stylesheet for cross-browser compatibility using Normalize.css version 3.0.2 (IE8+ only)
  2. Easy to customize
  3. Flexible grid from Chris Coyier
  4. Media Queries for mobile and tablets ready to populate
  5. Super fast preprocessing using Gulp and Libsass
  6. Super fast browser preview with live css injection using BrowserSync (similar to livereload).
  7. Much much more

Suggested Modules

Changelog

Version 1.0

  • initial version

Credits

Without these projects, this Drupal 7 Gulp Starter Theme wouldn't be where it is today.