Vapor CSS

Vapor CSS is Coveo's collection of UI components used in Coveo's Administration Console. All components and their documentation is available here

Install

npm install coveo-styleguide

Also available on our cdn :

static.cloud.coveo.com/styleguide/v1.x.y/css/CoveoStyleGuide.css

The project is at its early stages, some components can still have lots of breaking changes between versions.

Dependencies

jQuery (tested with 2.1.4)
Underscore (tested with 1.8.3)

Building

Make sure you have Node JS and NPM installed. Run npm install to get the required dependencies.

To build the dist folder and export it into the docs folder, simply run gulp docs.

Running documentation locally

# Install ruby package manager
gem install bundler
# Install this project packages
bundle install
# Build and run server
bundle exec jekyll server

# Open http://localhost:4000/styleguide/ in your favorite browser and voila!
open http://localhost:4000/vapor/

Test locally without publishing

To easily test the result locally without publishing a new package at each build:

Create a npm link of your local repository.
In your project, use that link to get the new package npm link coveo-styleguide
Rebuild your project, you will then see your changes applied.

Publishing on npm

All you need is to bump the version and re-publish the package on npm:

This requires an npm account with permission to publish to coveo-styleguide. Create an account if you don't have one and ask our team for publish access.

Install npm-release npm install -g npm-release
npm-release patch

Thanks

Vapor cherry picks from these awesome UI Libraries

Contributing

Search the issues, if it is not already there, add one.
Fork the repository
Code Code Code
Submit a pull request
Wait for some nice guy to review and merge

License

Vapor is distributed under Apache 2.0 license.

stemarco/vapor