Skip to content
A JavaScript library to draw pretty git graphs in the browser
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update GitHub templates to make labels work again Apr 12, 2019
assets/logo Add gitgraph logo into README - close #11 Sep 16, 2013
packages
.gitignore Versionned yarn.lock to force travis to use yarn Apr 12, 2018
.prettierignore Add ignored folders to .prettierignore Jul 7, 2018
.prettierrc Move Prettier up to lerna repo Jul 7, 2018
.travis.yml Make travis script executable Mar 23, 2019
CONTRIBUTING.md Update information in CONTRIBUTING.md Apr 12, 2019
LICENSE.md
README.md Add instructions to run the project locally Apr 12, 2019
jest.config.js
lerna.json
package.json Fix build script to run in all packages Apr 20, 2019
rollup.config.js Declare package as part of the same @gitgraph scope Feb 2, 2019
travis.sh
tslint.json Move tslint at root level Oct 21, 2018
yarn.lock Add CHANGELOG to @gitgraph/core Apr 16, 2019

README.md

GitGraph.js

A JavaScript library to draw pretty git graphs.


Build Status MIT License lerna

Getting started

GitGraph.js codebase is a monorepo. Packages are released under @gitgraph/* scope.

As a user, you're probably interested in one of the rendering libraries:

You'll find usage details in their README.

As a contributor, you might be interested in checking out gitgraph-core. It contains the core logic for rendering libraries to use.

Running the project locally

Pre-requisites:

Setting things up:

  1. Clone the repository: git clone git@github.com:nicoespeon/gitgraph.js.git
  2. Install dependencies: yarn install
  3. Bootstrap the project: yarn run lerna bootstrap

Lerna will install dependencies of all packages and links any cross-dependencies.

Available root-level commands are detailed in package.json. You would usually need:

  • yarn test to run Jest unit tests (yarn test --watch for watch mode)
  • yarn develop to start Storybook, watching for changes of all packages

You can also go to specific packages and run available commands detailed in their package.json. For example, you could cd packages/gitgraph-core/ and run yarn test --watch to only run tests of this package.

But root-level commands are more convenient!

Contributing

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to GitGraph.js.

Good First Issues

To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started.

Versioning

We use SemVer as a guideline for our versioning here.

Releases use the following format:

<major>.<minor>.<patch>
  • Breaking changes bump <major> (and reset <minor> & <patch>)
  • Backward compatible changes bump <minor> (and reset <patch>)
  • Bug fixes bump <patch>

Authors and contributors

Nicolas Carlo - @nicoespeon / https://nicoespeon.com

Fabien Bernard - @fabien0102 / https://fabien0102.com

0 1 2 3 4 5 6 7

Copyright and License

Copyright (c) 2013 Nicolas CARLO and Fabien BERNARD under the MIT license.

💁‍ What does that mean?

Thanks

Thanks to Chromatic for providing the visual testing platform that help us catch visual regressions for the rendering libs.

You can’t perform that action at this time.