ga-epd-wds v1.20.0

Georgia EPD-IT Web Design Standards

The GA-EPD-IT Web Design Standards contain reusable UI components and visual styles to create consistent experiences across Georgia EPD websites.

This project is based on the U.S. Web Design Standards.

Production setup

• The dist directory contains generated and optimized files for use in production.
• The src directory contains SASS source files for development.

Installation

To include the compiled distribution files as a dependency in your project, run npm install --save ga-epd-wds in your project folder (you will only get the dist folder). Then add a gulp task in gulpfile.js to copy the desired files to the appropriate destination. For example:

var paths = {
    webRoot: './wwwroot/',
    assetsRoot: './wwwroot/assets/',
    wdsRoot: './node_modules/ga-epd-wds/dist/**/*',
    wdsFavicons: './node_modules/ga-epd-wds/dist/epd-favicons/*',
};

gulp.task('ga-wds', function () {
    return gulp.src([paths.wdsRoot, '!' + paths.wdsFavicons])
        .pipe(gulp.dest(paths.assetsRoot));
});

gulp.task('ga-favicons', function () {
    return gulp.src(paths.wdsFavicons)
        .pipe(gulp.dest(paths.webRoot));
});

Favicons

See GA-EPD Brand for instructions on using EPD favicons.

Markup

See the U.S. Web Design Standards for a description of the classes and UI components available. Those classes are all prefixed with usa-.

Additional components developed by Georgia EPD-IT are prefixed with gaepd-.

Development setup

Node.js, NPM and Gulp are required.

Basic setup commands:

npm install
gulp

All available Gulp tasks:

• sass
• minify-css
• copy-uswds-sass
• copy-uswds-dist
• copy-gaepd-dist
• copy-all
• clean-css
• clean-dist
• clean-vendor-sass
• clean-all
• build-css
• default

Publishing a new version

Git working directory must be clean.

C:\...\ga-epd-wds>npm version <update_type>
C:\...\ga-epd-wds>npm publish

Where <update_type> is one of patch, minor, or major. For pre-release versions use premajor, preminor, or prepatch, and publish with npm publish --tag beta.