Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/quorumcontrol/dgit

dgit adds decentralized ownership to git - powered by Tupelo DLT and Skynet
https://github.com/quorumcontrol/dgit

Last synced: 8 days ago
JSON representation

dgit adds decentralized ownership to git - powered by Tupelo DLT and Skynet

Host: GitHub
URL: https://github.com/quorumcontrol/dgit
Owner: quorumcontrol
License: mit
Created: 2020-02-24T18:24:28.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2020-09-19T00:48:20.000Z (about 4 years ago)
Last Synced: 2024-08-01T22:41:50.259Z (4 months ago)
Language: Go
Homepage: https://dgit.dev/
Size: 437 KB
Stars: 208
Watchers: 15
Forks: 16
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://badges.mit-license.org)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)

decentragit

decentragit is an open-source project built by Quorum Control which combines
the power of
git, the Tupelo DLT and Skynet from Sia.

decentragit uses decentralized ownership and storage to make it trivial to
create a decentralized, shareable git remote of your project.

decentragit accomplishes this without changing your GitHub workflow except that you can keep collaborating when it goes down.

## Getting Started
With three simple steps you can create a decentralized mirror of your existing github project.
All changes will be automatically propogated to the mirror version and the git services you depend on will be there when you need them.

### Installation
A quick install using [brew](https://brew.sh/) gets you started:
```
brew tap quorumcontrol/dgit && brew install dgit
```
*Or if you don't have homebrew check out our [simple manual installation instructions](https://github.com/quorumcontrol/dgit/wiki/dgit-Install-without-Homebrew).*

### Usage
Next you will need to initialize each repo you want to make decentralized:
```
git dg init
```

This command does three things.

1. decentragit sets the appropriate remote urls in your repo's .git/config file.

2. decentragit creates a [ChainTree](https://docs.tupelo.org/docs/chaintree.html) which gets signed by the Tupelo DLT to specify ownership of the decentralized repo.

3. decentragit stores that repo on Skynet, the decentralized storage solution from Sia.

From there you can proceed with normal git commands.

If you ever want to pull from the mirror you can specify the mirror with a "dg:".

As an example:
`git clone dg://your_username/repo_name`

If you want to keep your decentralized, shareable git remote in sync with your GitHub repo adding
a simple github action as illustrated in [dgit-github-action](https://github.com/quorumcontrol/dgit-github-action) is all it takes. Once completed your decentragit decentralized shareable remote will always be up to date and ready when you need it.

#### Publish to dg-pages
New Feature! DGit now allows you to publish your frontend files (html, css, js, .vue, .react) files to Skynet.
Just checkout your files into a new branch named dg-pages, commit and push!

** NOTE: You need to have the Skynet CLI tool installed ** [skynet-cli-repo](https://github.com/NebulousLabs/skynet-cli)

#### Collaborators

You can manage your repo's team of collaborators with the `git dg team` command:

* `git dg team add [collaborator usernames]`
* `git dg team list`
* `git dg team remove [usernames]`

Anyone on the team will be allowed to push to the repo in the current directory.

#### Configuration

- Username can be set any of the following ways:
- `DG_USERNAME=[username]` env var
- `git config --global decentragit.username [username]` sets it in `~/.gitconfig`
- `git config decentragit.username [username]` sets it in `./.git/config`

### FAQ

You can find answers to some of the most [frequently asked questions on the wiki](https://github.com/quorumcontrol/dgit/wiki/Frequently-Asked-Questions).

### Built With

* [Git](https://git-scm.com/)
* [Tupelo DLT](https://docs.tupelo.org/)
* [Skynet](https://siasky.net/)

### Building
- Clone this repo.
- Run `make`. Generates `./git-dg` in top level dir.

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## License

Distributed under the MIT License. See `LICENSE` for more information.

## Contact

If you have any questions or concerns please [hop into our developer chat](https://gitter.im/quorumcontrol-dgit/community)
on gitter and we will be glad to help.

Project Link: [https://github.com/quorumcontrol/dgit](https://github.com/quorumcontrol/dgit)