README.md

gource-view

Gource generator for github organization.

Requirements

• Node.js v12 or higher
• Gource
• Sed version 4 or higher on your local system.

⚠️ gource.cmd must be available in the Windows path

Getting Started

$ git clone https://github.com/SlimIO/Gource-view.git
$ cd Gource-view
$ npm ci
$ npm start

Environment Variables

To configure the project you have to register (set) environment variables on your system. These variables can be set in a .env file (that file must be created at the root of the project).

GIT_TOKEN=
GITHUB_ORGA=SlimIO

To known how to get a GIT_TOKEN or how to register environment variables follow our Governance Guide.

Creating categories

It's possible to create categories (like branch) by creating a config file for your Organization (like SlimIO). For example please take a look at src/config/SlimIO.json.

Dependencies

Name	Refactoring	Security Risk	Usage
@slimio/is	Minor	Low	Type Checker
dotenv	Minor	Low	Loads environment variables from .env
fetch-github-repositories	Minor	Low	Fetch github repositories
isomorphic-git	⚠️Major	High	JavaScript GIT Implementation
make-promises-safe	Minor	Low	Force Node.js DEP00018

License

MIT