Home

Welcome to kitten!

Kitten is a front-end components library based on Sass and React. It is meant to be used on KissKissBankBank & Co platforms.

Installation

Kitten is both a gem and a npm module:

• The npm module exposes the scss and js assets. It can be used on its own.
• The gem provides a styleguide when it is included in a Rails application.

Here are some documentation sheets on installation for your app:

• Webpack configuration

Contribution guidelines

As Kitten is a library intended to be used on several platforms and by many people, we want it to be as scalable as possible. With this purpose in mind, we listed some best practices and conventions to follow when writing CSS, Sass and JavaScript for this project.

CSS components

• CSS writing
• Naming conventions

React

• Create a new React component
• Component testing

Styleguide

Our library provides a styleguide page if you include Kitten with the gem in a Rails application.