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.inc.examplefile toconfig.incand fill out the configuration.
You should now have a fully functioning TimeLord project up and running.
The local setup requires Docker and docker-compose.
Copy .env.example to .env and update the variables according to your harvestapp.com credentials, eg.:
HARVESTER_HARVEST_USER=harvest@example.com
HARVESTER_HARVEST_PASSWORD=secret
HARVESTER_HARVEST_ACCOUNT=companyname
docker-compose up will now give you a working timelord and harvester. First time building Harvester will take a long time importing the database.
Alternately, you can edit config.inc and insert a remote URL to a Harvester environment, and then just docker-compose up timelord. Your local Time Lord container will then fetch data from the remote Harvester environment.
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.
First build the node container and install dependencies:
docker-compose build --force-rm node && \
docker-compose run --rm node npm install && \
docker-compose run --rm node bower install
To recompile everything, simply run grunt from inside the container:
docker-compose run --rm node grunt