mirror of https://github.com/MichaelMure/git-bug.git synced 2024-12-14 17:51:44 +03:00

Distributed, offline-first bug tracker embedded in git, with bridges

bugtracker decentralized-application distributed-systems git gitdb starred-michaelmure-repo starred-repo

Go to file

Michael Muré 26e7ce44db upgrade the readme		2018-08-06 03:26:42 +02:00
bug	bug: store the referenced media in their own git tree under /media, as per the doc I wrote myself	2018-08-05 15:26:36 +02:00
cache	implement media hosting in git for comments + API for the webui	2018-08-02 23:37:49 +02:00
commands	implement media hosting in git for comments + API for the webui	2018-08-02 23:37:49 +02:00
doc	upgrade the readme	2018-08-06 03:26:42 +02:00
graphql	implement media hosting in git for comments + API for the webui	2018-08-02 23:37:49 +02:00
input	termui: implement addComment and setTitle	2018-08-02 16:35:13 +02:00
misc	upgrade the readme	2018-08-06 03:26:42 +02:00
repository	graphql: implement the missing mutations	2018-08-01 21:57:12 +02:00
termui	termui: more work on the show bug window	2018-08-03 17:29:53 +02:00
tests	fix test	2018-08-02 23:45:40 +02:00
util	util: add a Lamport clock implementation as well as a persistable one	2018-08-05 15:27:46 +02:00
vendor	graphql: simplify the requests with helpers	2018-08-01 19:24:19 +02:00
webui	webui: Use the new schema	2018-07-31 00:18:55 +02:00
.gitignore	upgrade the readme	2018-08-06 03:26:42 +02:00
.travis.yml	travis: now I remember why i removed codegov	2018-08-04 12:39:12 +02:00
git-bug.go	upgrade the readme	2018-08-06 03:26:42 +02:00
Gopkg.lock	graphql: simplify the requests with helpers	2018-08-01 19:24:19 +02:00
Gopkg.toml	vendor gocui on the master branch because of no release in a while	2018-07-30 18:22:52 +02:00
LICENSE	Create LICENSE	2018-07-12 12:54:04 +02:00
Makefile	cleanup webui	2018-07-17 02:10:04 +02:00
Readme.md	upgrade the readme	2018-08-06 03:26:42 +02:00

Readme.md

git-bug

Bugtracker embedded in Git

Would it be nice to not have to rely on a web service somewhere to deal with bugs ?

Would it be nice to be able to browse and edit bug report offline ?

git-bug is a bugtracker embedded in git. It use the same internal storage so it doesn't pollute your project. As you would do with commits and branches, you can push your bugs to the same git remote your are already using to collaborate with other peoples.

🚧 This is for now a proof of concept. Expect dragons and unfinished business. 🚧

Install

go get github.com/MichaelMure/git-bug

If it's not done already, add golang binary directory in your PATH:

export PATH=$PATH:$GOROOT/bin:$GOPATH/bin

That's all ! In the future, pre-compiled binary will be provided for convenience.

CLI usage

Create a new bug:

git bug new

Your favorite editor will open to write a title and a message.

You can push your new entry to a remote:

git bug push [<remote>]

And pull for updates:

git bug pull [<remote>]

List existing bugs:

git bug ls

You can now use commands like show, comment, open or close to display and modify bugs. For more details about each command, you can run git bug <command> --help or read the command's documentation.

Interactive terminal UI

An interactive (WIP) terminal UI is available using the command git bug termui to browse and edit bugs.

// TODO: replace with less test data ;-)

Web UI

You can launch a rich Web UI (terribly WIP) with git bug webui.

This web UI is entirely packed inside the same go binary and serve static content through a localhost http server.

The web UI interact with the backend through a GraphQL API. The schema is available here.

Note: the compiled web UI is not commited in git for now so you will have to install npm packages and build it before compiling the go binary.

Internals

Interested by how it works ? Have a look at the data model.

Misc

Planned features

interactive CLI UI
rich web UI
media embedding
import/export of github issue
inflatable raptor

Contribute

PRs accepted.