chrnorm / radicle-upstream

Desktop client for Radicle.

Upstream

Upstream is a cross-platform desktop client for the radicle code collaboration protocol.

At the moment we support Linux and macOS. Later on we'll provide ready-made packages for both platforms, however for now a good way to explore the project is to read the documentation and have a go at building it locally.

The UI is written in JavaScript using Svelte and Electron and the node proxy logic is implemented in Rust.

A good entry point for exploration is DEVELOPMENT.md, where you'll find information on how to build Upstream from source.

If you're looking to contribute, take a look at CONTRIBUTING.md to learn about the different ways that we accept contributions.

If you have questions or would like to get in touch, check out radicle.community.

Building and running Upstream

Prerequisites

• NodeJS
• Yarn
• Rustup

To build upstream run

yarn run dist

This command will create an application package in the ./dist folder which you can then run.

Attribution

Upstream uses:

• Twemoji by Twitter
• The Inter typeface family by Rasmus Andersson
• Source Code Pro font family by Adobe