Getting started

A quick tour on Furatto, basic usage, examples and more.

Getting started

Whether you are using Scss or CSS, it is really easy to start a project and get things done in a short amount of time.

Furatto is developed in Sass, which is a CSS meta-language that helps you write cleaner and more elegant CSS so that is easier to maintain over time without the headaches of pure CSS. On top of the styling, we've written some Javascript plugins, developed in Coffeescript so that is easier to read and mantain along the way, and which are going to improve user interactions on multiple screen sizes.


Looking for version 1?

Many changes were made from version 1, but don't worry we still have support for it. You can view the old documentation or download it as a package.

Download Documentation


What's included?

Within the download Furatto comes with the following files and directories structure, based on a logical common pattern which makes the acces faster and easier to maintain.

Once you've downloaded and unzip the compressed folder, you should see something like this:

 
                
  furatto/
  ├── css/
  │   ├── furatto.css
  │   ├── font-awesome.css
  │   ├── docs.css
  │   ├── examples.css
  │   ├── normalize.css
  ├── examples /
  │   ├── basic_setup.html
  │   ├── carousel.html
  │   ├── landing.html
  │   ├── login.html
  │   ├── thumbnails.html
  │   ├── assets /
  ├── js/
  │   ├── furatto.js
  │   ├── furatto.min.js
  │   ├── furatto-demo.js
  │   ├── jquery.js
  │   ├── shell-rainbow.min.js
  ├── scss /
  │   ├── docs.scss
  │   ├── font-awesome.scss
  │   ├── furatto.scss
  │   ├── normalize.scss
  │   ├── furatto /
  ├── img/
  │   ├── 1.png
  │   ├── ...
  └── fonts/
      ├── meteocons-webfont.eot
      ├── meteocons-webfont.svg
      ├── meteocons-webfont.ttf
      ├── meteocons-webfont.woff
      └── fontawesome 
          ├── fontawesome-webfont.eot
          ├── fontawesome-webfont.svg
          ├── fontawesome-webfont.ttf
          ├── fontawesome-webfont.woff
          └── FontAwesome.otf
                
              

This is the basic structure of Furatto: it contains the compiled versions of css(furatto.*.css) and javascript(furatto.*.js) for a quick drop-in to almost any web project. Fonts Awesome is included by default in the css file.

jQuery based plugins

Note that all the furatto plugins require jQuery to be included. It is included by default.


Basic Setup

Our markup layout is pretty straight forward, and the example below shows a basic HTML template for you to start. We encourage you to go to the Examples section and look at some we provided.

Meta Viewport tag

This is used to make sure smaller devices use the correct width as the viewporth width, as well as it prevents the zoom in/out gesture.

CSS

We included the normalize.css and furatto.min.css in the head tag. You can use wheter the minified or full version of the compiled CSS.

Javascript

The JS is linked up before the closing tag , in order to improve performance, as well as it contains all the necessary plugins and initializers to get up and running.

Absolute positioned

The layout is built using two main absolute elements panels and panel-content in order to provide the left drawer slide effect on small devices.

Plugins

The javascript plugins provided by Furatto use jQuery, so it is necessary for you to include jQuery in your layout. jQuery v2.0.2 is located under the assets/js directory.

Assets

An assets directory with the necessary css, js, fonts and images is included in the furatto.zip file you downloaded.


Browser support

Furatto is developed to work best with the latest desktop and mobile browsers, meaning that legacy browsers might not render as nice as you might think, also some jQuery plugins may not work as expected.


Supported browsers
  • Chrome (Mac, Windows, iOS, and Android)
  • Safari (Mac, iOS)
  • FireFox (Mac, Windows, and Android)
  • Internet Explorer (Some issues may present)
  • Opera (Mac, Windows)

IE caveats

Some CSS3 properties may not display correctly(border-radius), as well as hardware acceleration CSS transitions.


Using rails

We provide a gem which plays well with any Rails app, you can check it out at https://github.com/IcaliaLabs/furatto-rails, it includes all the styling and jQuery plugins for a full integration. A quick tutorial is provided below:


License

Furatto is under the Apache 2 license. In small words it can be described with the following conditions.

It allows you to:
  • Free to use and download Furatto, as a whole or in parts, for personal, company or commercial purposes
  • You can use Furatto in distributions you create.
It forbids you to:
  • Redistribute any piece of Furatto without proper attribution
It requires you to:
  • Include a copy of the license in any redistribution you may make that includes Furatto.
  • Provide clear attribution to the authors for any distributions that include Furatto.
It does not require you to:
  • Include a source of Furatto itself, or of any modifications you may perform.
  • Submit changes that you make to Furatto back to the Furatto project.

The license section style was based on the one on Bootstrap.