badger

Badger is a dashboard for viewing Key Performance Indicators for Github projects in a grid; namely, those fancy badges at the top of README.md files.

Development

There are a few ways to get the project started.

Vagrant Quickstart

This sets up a sandboxed Ubuntu instance with MongoDB and NodeJS 4.2.2. Development tools such as Git, oh-my-zsh, and emacs are installed.

Prerequisites:

• Vagrant
• Virtualbox
• Ruby

> ./quickstart.sh
> vagrant ssh
> npm run develop

Docker-Compose

This starts up the application's development loop. The node_modules directory is not synced to the host, so you can run docker-compose and localhost development simultaneously.

Prerequisites:

• Docker

> docker-compose up
> docker-compose run app npm run develop

Localhost

Basic NodeJS installation procedure, requires a running database and a recent version of NodeJS.

Prerequisites:

• NodeJS 4.x
• MongoDB

> npm install 
> npm run develop

Project Layout

└─── client/  (Client Code, ReactJS)
└─── config/  (Configuration Management)
└─── gulp/    (Build System Definition) 
└─── scripts/ (Git, NPM, and Utility Scripts)
└─── server/  (NodeJS Server Code)