fuse

module
v1.0.0-beta Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 13, 2022 License: MIT

README

Go Report Card CI Worker (Golang) CI Frontend (UI) Twitter Follow Slack Community

mergestat MergeStat Logo

MergeStat enables SQL queries for data in git repositories (and related sources, such as the GitHub API). It allows you to ask questions about the history and contents of your source code.

If you are looking for our CLI, which runs SQL queries against local git repositories, it's now called mergestat-lite

See our documentation for additional context.

MergeStat Illustration

Running Locally

Try MergeStat locally with docker-compose by cloning this repository and running

docker-compose up

Now if you visit http://localhost:3300/ you should be able to access our management UI where you can begin adding repositories and syncing data.

NOTE if you'd like to make use of GitHub API data (any sync type that uses the GitHub API including repo auto imports) or any private GitHub repos you will need to supply a GitHub personal access token. We are working on GitHub auth alternatives, but for now a PAT is your best bet.

MergeStat GitHub PAT Management UI

You can manage a single PAT for your instance in the Settings area of the management UI.

Examples

Take a look at all of our examples

You can also visit http://localhost:3000/ to access a local Grafana instance with example dashboards using the data from MergeStat 🎉 :

MergeStat Example Dashboards
Resetting a Local Instance

If you'd like to "start from scratch" (i.e. reset the DB and start with a fresh deployment), run the following:

docker-compose down
docker volume rm fuse_db_data

Directories

Path Synopsis
cmd
worker command
internal
db
syncer
Package syncer handles syncing of repositories
Package syncer handles syncing of repositories
pkg
sqlite
Package sqlite provides a golang target that depends on sqlite's C amalgamation file.
Package sqlite provides a golang target that depends on sqlite's C amalgamation file.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL