Chico UI

Chico UI is a free and open source collection of easy-to-use UI components for designers and developers.

Get things done, quickly.

Development setup

1. Install Git and NodeJS.

2. Open your terminal and clone mercadolibre/chico by running:

    $ git clone [email protected]:mercadolibre/chico.git
   

3. Now go to the project's folder:

    $ cd chico
   

4. Install its dependencies:

    $ npm install
   

5. Install grunt-cli:

    $ npm install grunt-cli -g
   

6. Run a local web server:

    $ npm start
   

   Navigate http://localhost:3040 and http://localhost:3040/mobile.

7. Develop! :)

NOTE

Please read through our code style guides:

• HTML
• CSS
• JavaScript

## API Doc

[Temporally] Before run grunt doc, change this file with:

else {

    var newUrl = url.replace('ch.', '/chico/api-doc/'+options.cssClass+'/');
    newUrl = newUrl.toLowerCase();
    newUrl = newUrl.replace('.html', '');

    return util.format('<a href="%s%s"%s>%s</a>', newUrl, fragmentString, classString, text);
}

You can read our API Doc.

The API doc may also be run locally by running:

grunt doc

Navigate ./api-doc/version directory and enjoy!

## API Doc to gh-pages

You can publish the API Doc to gh-pages following these steps:

1. Run locally from master branch:

    $ grunt docToSite
   

2. Run locally from gh-pages branch:

    $ git pull origin gh-pages
    $ npm install
    $ grunt getVersion
    $ jekyll build
   

3. Commit and push the updates files

## Tests You can run our tests in your browser:

1. Run the local web server:

    $ npm start
   

2. Navigate http://localhost:3040/test/:component

We are going to automate it! :)

## Get in touch

• E-mail: chico at mercadolibre dot com
• Twitter: @chicoui
• Web: http://chico-ui.com.ar/

## Maintained by

• Her Mammana (@hmammana)
• Lean Linares (@lean8086)

## Thanks to

• Guille Paz (@pazguille).
• Natan Santolo (@natos). Creator and former leader, now traveling around the world, drinking beer and looking for the secret of eternal life.
• Nati Devalle (@taly). Because we love her. She is awesome!

## Credits

## License Licensed under the MIT license.

Copyright (c) 2014 MercadoLibre.