Timelord is a way to visually present data provided by the Harvester project. If you don't know what Harvester is, please go to the project and checkout the README file.
There is only a few steps you need to follow for Timelord to be functioning with your Harvester project:
- Clone the repository
git clone https://github.com/reload/timelord.git
- Copy the
config.incand fill out the configuration.
You should, by now, have a fully functioning TimeLord project up and running. If you wish to customize the project, checkout the "Customize" section below.
We have setup a few steps that you should follow to get a fully customizable version up and running, if you wish to alter the styling or create further functionality.
This guide is based on OSX. If you run linux you are smart enough to figure it out by yourself.
We use NodeJS/NPM to get our Grunt dependencies and install Bower:
brew install node
Get components (defined in package.json) by running:
We user Bower to get the libraries that we need (AngularJS and it's dependencies etc).
npm install -g bower
Then install libraries (defined in bower.json)
We use the Compass SASS Framework to compile our CSS and provide easy cross browser support (mixins).
gem install compass
You need grunt on your system.
npm install -g grunt
Then just simply run
grunt and it will compile and enter watch mode.
If you have the 'Live reload' plugin, you can use it in watch mode.
If you have NodeJS and Compass installed: Clone repo, then run:
npm install && bower install && grunt