f / perr

Perr UI Library using CoffeeScript

perr v0.0.0

v0.0.0 means, there's nothing working right now. It's development just started. We'll all see what it'll look like. :)

Perr is a simple UI framework to build rich internet applications.

API Documentation

The best part of the documentation.

TODO

Geek Part of Readme File

If you are not a contributor or a geek, you'll never need that part. But if you want to learn how it runs, read. :)

Perr built on Backbone.js power.

Complete list of the tools while building Perr:

• Underscore.js
• Backbone.js
• CoffeeScript
• QUnit with PhantomJS
• jQuery
• UglifyJS2

Setup Development Environment

Install Core Requirements

On Linux:

sudo apt-get install git nodejs npm

On Mac OS X:

If you don't have Homebrew, then install it first:

ruby -e "$(curl -fsSkL raw.github.com/mxcl/homebrew/go)"

brew install nodejs
curl https://npmjs.org/install.sh | sh

sudo npm install -g grunt
sudo npm install -g phantomjs
sudo npm install -g uglify-js2

Pulling the Repo and Submodules

git clone https://github.com/fkadeveloper/perr.git
cd perr
git submodule update --init --recursive
cd lib/jquery && npm install && grunt && cd -

Testing and Building

Console Test: test/run to start test.

Web UI Test: open test/index.html to start test on Browser.

### Building

./build to start building.

Todo

• Do something working!!! important
• DON'T FORGET TO WRITE DOCS ON EVERY MOVE!

License

This is a Free Software and licensed with GPLv3