Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/radicle-dev/radicle-upstream
Desktop client for Radicle.
https://github.com/radicle-dev/radicle-upstream
Last synced: about 17 hours ago
JSON representation
Desktop client for Radicle.
- Host: GitHub
- URL: https://github.com/radicle-dev/radicle-upstream
- Owner: radicle-dev
- License: other
- Archived: true
- Created: 2019-08-12T13:26:09.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-08-01T07:37:22.000Z (over 2 years ago)
- Last Synced: 2024-08-01T20:49:33.937Z (3 months ago)
- Language: Svelte
- Homepage:
- Size: 28.5 MB
- Stars: 615
- Watchers: 14
- Forks: 51
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-starred - radicle-dev/radicle-upstream - Desktop client for Radicle. (others)
README
# ⚠️ Upstream has been sunsetted ⚠️
Read more about it [here](https://radicle.community/t/upstream-july-2022-community-update).
To discover and interact with projects on the Radicle protocol, please use the
[web app](https://app.radicle.network) and [Radicle CLI](https://radicle.network)
tooling.
-------------------------------------------------------------------------------
Upstream is a cross-platform desktop client for the Radicle code collaboration
protocol.
At the moment we support Linux and macOS. Latest packages for these platforms
are available on the [Radicle website][rw].
Windows support is considered experimental at this stage -- we don't provide
packages for this platform, so you'll have to build it from source.
The [UI][ui] is written in JavaScript using [Svelte][sv] and Electron and the
node [proxy][pr] logic is implemented in [Rust][ru].
A good entry point for exploration is [`development.md`][de], where you'll find
information on how to build Upstream from source.
If you're looking to contribute, take a look at [`contributing.md`][co] 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][rc].
## Building and running Upstream
Prerequisites
* [NodeJS](https://nodejs.org/en/)
* [Yarn](https://yarnpkg.com/getting-started/install)
* [Rustup](https://github.com/rust-lang/rustup)
To build Upstream, run
```bash
yarn install
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][tw]
- [The Inter typeface family by Rasmus Andersson][ra]
- [Source Code Pro font family by Adobe][so]
[bb]: https://github.com/radicle-dev/radicle-upstream/actions/workflows/build.yaml/badge.svg?branch=main
[bu]: https://github.com/radicle-dev/radicle-upstream/actions/workflows/build.yaml
[co]: docs/contributing.md
[db]: https://github.com/radicle-dev/radicle-upstream/actions/workflows/dist.yaml/badge.svg?branch=main
[dd]: https://github.com/radicle-dev/radicle-upstream/actions/workflows/dist.yaml
[de]: docs/development.md
[pr]: proxy
[ra]: https://rsms.me/inter
[rc]: https://radicle.community
[ru]: https://www.rust-lang.org
[rw]: https://radicle.xyz/downloads.html
[so]: https://adobe-fonts.github.io/source-code-pro
[sv]: https://svelte.dev
[tw]: https://twemoji.twitter.com
[ui]: ui