the-vision

#The Vision ####The front end framework for an Indix experience

All Indix apps need to provide consistent experience for users from a branding, look and feel. To accomplish this, developers need a framework that can be used across the company.

##Style Guide This is the visual guide to all experiences.

##Using components from The Vision project Visit oss.indix.com/the-vision for documentation on how to use the components in the framework.

##Dev setup to run the project locally

####Basic Setup

• Checkout the code.
• Run sh boostrap.sh

• Sets up git hooks
  • pre-commit runs the build and adds it before/for every commit
• Runs nvm use to switch to the right node version.
• Runs npm install to install all the dependencies. This may take a while.

• Run bundle install to install a few dev-dependencies (Middleman).
  If the previous step fails, install the correct version of ruby. We suggest using rvm gemsets.

####Starting Development

• Fire up using middleman server.
• Open localhost:4561 to view the app.
• Changes to the source code auto-refreshes the browser.
• In a parallel window, run npm run develop to run webpack in watch mode. This bundles the js file.

####Publish a new component

• Add tests
• Add docs
• Update version
• Send a PR

####Update the webpage Run npm run publish-page -- "<commit msg>" to push the static files to gh-pages branch.