npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@piotrpdev/gitline

v1.0.6

Published

Graphical git UI

Downloads

11

Readme

gitline example

gitline - A git history to HTML renderer implemented in TypeScript

[!NOTE] This is a fork of the original project by blecher-at. This fork updates the project to a more modern approach and removes a lot of libraries that are no longer needed.

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.

Usage

NPM

An NPM package is available for this project. You can see typical usage in src/demo/.

It usually looks something like this:

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <title>Gitline Example</title>

    <!-- jQuery required by JSGL -->
    <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/jquery.min.js"></script>
    <!-- JSGL used for generating pretty SVG Git lines -->
    <script src="https://cdn.jsdelivr.net/gh/jsgl/repo@6231386/jsgl.min.js"></script>
    <!-- Optional styles to make stuff look nice -->
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@piotrpdev/[email protected]/dist/gitline.min.css"/>
    <!-- This library -->
    <script src="https://cdn.jsdelivr.net/npm/@piotrpdev/[email protected]/dist/gitline.umd.min.js"></script>
  </head>
  <body>
    <div id="myGitlinePanel-1"></div>

    <script>
      Gitline.create()
        .fromJSON(`assets/data/example02.json`)
        .withHeader("<h1>My Gitline</h1>")
        .renderTo(document.querySelector("#myGitlinePanel-1"));
    </script>
  </body>
</html>

Creating sample data

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

Imports / Third party

Development

  • Install Node.js
  • Install dependencies: npm install
  • Build the library: npm run build
  • View the examples: npm run dev:demo
  • Test the library: npm run test

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.