Code Monkey home page Code Monkey logo

vapor's Introduction

logo npm Build Status dependencies dev-dependencies license

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

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:

  1. Create a npm link of your local repository.
  2. In your project, use that link to get the new package npm link coveo-styleguide
  3. 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.

  1. Install npm-release npm install -g npm-release
  2. npm-release patch

Thanks

Vapor cherry picks from these awesome UI Libraries

Contributing

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

License

Vapor is distributed under MIT license.

vapor's People

Contributors

jplachance avatar pochretien avatar wfortin avatar marilynechan avatar pmarcl avatar germainbergeron avatar sroy3 avatar greenkeeperio-bot avatar pastjean avatar rousselm4 avatar frederik-labbe avatar guisim avatar jcbeaupre avatar eredian avatar

Watchers

James Cloos 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.