https://github.com/mergestat/mergestat

MergeStat enables anyone to ask questions about the history and contents of source code.
https://github.com/mergestat/mergestat

database github golang postgres

Last synced: 7 days ago
JSON representation

MergeStat enables anyone to ask questions about the history and contents of source code.

• Host: GitHub
• URL: https://github.com/mergestat/mergestat
• Owner: mergestat
• License: mit
• Created: 2022-02-22T15:20:50.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-30T03:42:38.000Z (about 1 month ago)
• Last Synced: 2024-11-29T18:02:52.923Z (14 days ago)
• Topics: database, github, golang, postgres
• Language: TypeScript
• Homepage: https://docs.mergestat.com/
• Size: 51.8 MB
• Stars: 482
• Watchers: 10
• Forks: 44
• Open Issues: 109
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

• awesome-golang-repositories - mergestat
• charm-in-the-wild - mergestat - Run SQL queries on git repositories. (_built with Bubble Tea_) (Applications / Development Tools)

README

        
[![Go Report Card](https://goreportcard.com/badge/github.com/mergestat/mergestat)](https://goreportcard.com/report/github.com/mergestat/mergestat)

[![CI Worker (Golang)](https://github.com/mergestat/mergestat/actions/workflows/ci-worker.yaml/badge.svg)](https://github.com/mergestat/mergestat/actions/workflows/ci-worker.yaml)

[![CI Frontend (UI)](https://github.com/mergestat/mergestat/actions/workflows/ci-frontend.yaml/badge.svg)](https://github.com/mergestat/mergestat/actions/workflows/ci-frontend.yaml)

[![Twitter Follow](https://img.shields.io/twitter/follow/mergestat)](https://twitter.com/mergestat)

[![Slack Community](https://badgen.net/badge/icon/slack?icon=slack&label)](https://join.slack.com/t/mergestatcommunity/shared_invite/zt-xvvtvcz9-w3JJVIdhLgEWrVrKKNXOYg)

# mergestat 

  

  

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`](https://github.com/mergestat/mergestat-lite)**

See our [**documentation**](https://docs.mergestat.com/) for additional context.



## Running Locally

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

```sh

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](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).

We are working on GitHub auth alternatives, but for now a PAT is your best bet.



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](./examples)

### 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 mergestat_db_data

```