https://github.com/radicle-dev/heartwood

❤️🪵 Radicle Heartwood Protocol & Stack
https://github.com/radicle-dev/heartwood

Last synced: 7 days ago
JSON representation

❤️🪵 Radicle Heartwood Protocol & Stack

• Host: GitHub
• URL: https://github.com/radicle-dev/heartwood
• Owner: radicle-dev
• License: apache-2.0
• Archived: true
• Created: 2022-09-13T08:12:30.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-04-24T11:31:39.000Z (7 months ago)
• Last Synced: 2024-08-01T15:35:41.090Z (3 months ago)
• Language: Rust
• Homepage: https://app.radicle.xyz/seeds/seed.radicle.xyz/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5
• Size: 5.17 MB
• Stars: 137
• Watchers: 9
• Forks: 27
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# ❤️🪵

*Radicle Heartwood Protocol & Stack*

Heartwood is the third iteration of the Radicle Protocol, a powerful

peer-to-peer code collaboration and publishing stack. The repository contains a

full implemention of Heartwood, complete with a user-friendly command-line

interface (`rad`) and network daemon (`radicle-node`).

Radicle was designed to be a secure, decentralized and powerful alternative to

code forges such as GitHub and GitLab that preserves user sovereignty

and freedom.

See the [Protocol Guide](https://radicle.xyz/guides/protocol) for an

in-depth description of how Radicle works.

## Installation

**Requirements**

* *Linux* or *Unix* based operating system.

* Git 2.34 or later

* OpenSSH 9.1 or later with `ssh-agent`

### 📀 From binaries

> Requires `curl` and `tar`.

Run the following command to install the latest binary release:

    curl -sSf https://radicle.xyz/install | sh

### 📦 From source

> Requires the Rust toolchain.

You can install the Radicle stack from source, by running the following

commands from inside this repository:

    cargo install --path radicle-cli --force --locked

    cargo install --path radicle-node --force --locked

    cargo install --path radicle-remote-helper --force --locked

Or directly from our seed node:

    cargo install --force --locked --git https://seed.radicle.xyz/z3gqcJUoA1n9HaHKufZs5FCSGazv5.git \

        radicle-cli radicle-node radicle-remote-helper

## Running

*Systemd* unit files are provided for the node and HTTP daemon under the

`/systemd` folder. They can be used as a starting point for further

customization.

Additionally, a `Dockerfile` is included under both crates.

For running in debug mode, see [HACKING.md](HACKING.md).

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) and [HACKING.md](HACKING.md) for an

introduction to contributing to Radicle.

## License

Radicle is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.