suretec-framework v0.0.16

Suretec Framework

Installation

Here is how to use the Suretec Framework with a new project. From your projects root directory...

• Run npm install suretec-framework --save
• From your project directory, run npm install
• Bring the img, js, and fonts directories into your projects root folder (Sample gulp task below)
• Compile SASS from node_modules/suretec-framework/scss/main.scss

// Copy Suretec Framework files from /node_modules
gulp.task('vendor', function() {

  // Suretec Framework JS
  gulp.src([
      './node_modules/suretec-framework/js/**/*'
    ])
    .pipe(gulp.dest('./js'))

  // Suretec Framework Images
  gulp.src([
      './node_modules/suretec-framework/img/**/*'
    ])
    .pipe(gulp.dest('./img'))

  // Suretec Framework Fonts
  gulp.src([
      './node_modules/suretec-framework/fonts/**/*'
    ])
    .pipe(gulp.dest('./fonts'))

});

NOTE: npm install will fail unless you have the .npmrc file with the Font Awesome Pro token included within your project directory!

You will then need to set up a Gulp task to compile the SCSS since the framework is a SASS framework and does not include compiled CSS. It is set up in this fashion so changing the color palette is easier from project to project.