Skip to content

blecher-at/gitline

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gitline sample

gitline - A git history to HTML renderer implemented in TypeScript

Travis CI Status

The idea is to have this on a central server or your local machine, to keep tabs on what your team is doing :) Needs a JSON file as input (generated with git2json)

gitline tries to be aware of your branching scheme. It will autodetect the category and assignment of branches and groups commits accordingly.

Run it on a server (requires docker)

docker run -dP -e REPO_URL="https://github.com/blecher-at/gitline" -e REPO_NAME="Gitline" blecherat/gitline

see https://github.com/blecher-at/gitline/tree/master/docker-image for more details

Installation / Setup of development environment

  • Install Node.js
  • Install Gulp globally: npm install -g gulp
  • Install dependencies in project's root folder: npm install
  • Run gulp watch in project's root folder in a second terminal window to compile TypeScript on the fly when a file changes
  • To run, execute gulp run in project's root folder, then visit http://localhost:3000/
  • To test, execute gulp test

Creating sample data

  • Install git2json
  • run git json > myfile.json - in a cronjob presumably
  • point src/index.html to the newly created JSON file

Imports / Third party

Legal / License

Licensed under the Affero GPLv3, which basically says: You are free to hack and use, but if you want to build a product out of it, or host it as a service, we need to talk.