To get started, checkout:
Table of contents
- Quick start
- Bug tracker & feature request
- Using Rails
- Using Furatto
Using Furatto is extremely easy, we've provided three quick start options:
- Download the latest release.
- Clone the repo:
git clone email@example.com:IcaliaLabs/furatto.git.
- Install via bower:
bower install furatto.
We recommend you read the Getting started guide for information about the contents, caveats and more.
Bug tracker & feature request
Have a bug or a feature request? Please open a new issue. Before opening any issue, please search for existing issues.
We recommend you to read the version milestiones if you feel like want to collaborate.
Running documentation locally
- You need to install Jekyll or run
- From the root of the project
jekyll serve --watchfrom the command line, this way if you change any file jekyll will generate that for you.
- Open http://localhost:9001/furatto and you are good to go.
Jekyll is a great way to work with static pages, we definitely recommend you take a look at the documentation.
We encourage you to migrate to version 3 as is a more stable, friendly and extendable version.
Furatto V3 now uses Grunt to compile all the Sass code and start working with the framework. Before getting started you need to add the necessary dependencies:
From the command line:
npm install -g grunt-cli.
- Navigate to the root
/furattodirectory, then run
npm install. npm will look at package.json and automatically install the necessary local dependencies listed there.
If you need to install npm, or you are not quite sure what it is, here is a quick link for you to get started. NPM
Available Grunt tasks
Some of the grunt tasks are:
This task will build the whole framework, which means, sass compilation, coffeescript compilation, dist directory creation, compression of files and more.
We have a very useful workflow to work with Furatto and Grunt:
jekyll serve --watchfrom the command line on the root folder
- In another terminal run
grunt watch, which will be pending of any change on any coffeescript or sass file. It will compile everything up and deliver it to Jekyll, which by receiving the change will regenerate the necessary files.
We also include livereload to reload when the watch task is over, for more info refer to the our Gruntfile
Please submit all pull requests against a separate branch. Please follow the standard for naming the variables, mixins, etc.
In case you are wondering what to attack, we hnow have a milestone with the version to work, some fixes and refactors. Feel free to start one.
Keep track of new feautres, development issues and community news.
We will love to hear wheter you are using Furatto for testing, prototyping or online sites, checkout who is in already here
Copyright and license
Code and documentation copyright 2013-2014 Icalia Labs. Code released under the MIT license.