Coder Social home page Coder Social logo

ux-prototype's Introduction

Built with Grunt

UX Prototype

GitHub version

Go from sketch to wireframe to prototype with this front-end development and design kit by generating static HTML pages from dynamic templates and partials, and modular CSS structure using SASS, allowing you to keep everything organised the way you need it to be.

We’re not designing pages, we’re designing systems of components

Stephen Hay

Project Goal

Enable the building and demonstration of tangible products and reduce describing and documenting them, by facilitating "in-browser design" ("deciding in the browser") using:

  • A modular/atomic system of reusable components/patterns
  • Flexible tools – opt-in over opt-out

Features

All features are optional, if you don't want to use one just comment it out in the appropriate tasks/task-name.js file. Everything is highly configurable and automated with Grunt.

  • Modular templating and partial/includes system (Handlebars) – Assemble
  • CSS pre-processing – SASS
  • Livereload your designs instantly after saving on multiple devices (without a browser plugin)
  • SVG conversion to PNG and Base64 encoded CSS for fallback - Grunticon
  • Package/asset management (jQuery, modernizr, etc.) - Bower
  • Minification of JS and CSS
  • Image optimisation
  • Rule based linting of JS, CSS, HTML and Accessibility
  • Reordering/formatting of CSS according to rules you set – CSSComb
  • HTML beautification according to rules you set – Prettify
  • Growl notifications

The Sass/CSS adheres somewhat closely to the following guidelines (needs cleanup):

Install

NOTE: This will eventually all be handled by a script (optional).

If you are unfamiliar with terms like homebrew, npm, ruby and bundler or are having difficulty with the instructions below, read the full install instructions.

If you already have node installed, read on.

SASS, Compass and Bundler

gem install sass compass bundler

Grunt & Bower

npm install -g grunt grunt-cli bower

Dependencies

npm install && bower install && bundle install

Growl

growlnotify

How to use

NOTE: Need to elaborate on this

A lot of the variables are defined in Gruntfile.js and also in package.json.

Source files are in the src directory and the static/flat output is output to the build directory.

Working on source files

Start a server with livereload and edit your HTML (.hbs), SASS or js files from the src and have the changes update in the browser without refreshing.

grunt serve

Building static output

After you have changed any of the source files, generate new files in the build directory by running the following command:

grunt build

HTML (.hbs) pages

Assemble docs

Most page and directory relatred settings are in tasks/options/assemble.js.

Alternatives

Author

Michael Sheedy

Credit

Matt Bailey's bones generator and his blog posts on using Grunt – the seed that started this project.

ux-prototype's People

Contributors

sheedy avatar ih2502mk avatar

Watchers

James Cloos avatar Jibo He 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.