Files
radicle-explorer/README.md
T
Rūdolfs Ošiņš 5dc035252b Update README with GH Actions badges
We dropped the woodpecker pipeline, switching to gh actions in the
interim while radicle-ci is cooking. Also update install instructions.
2026-03-23 16:51:15 -06:00

53 lines
1.8 KiB
Markdown

# Radicle Desktop
[![lint](https://github.com/radicle-dev/radicle-desktop/actions/workflows/lint.yaml/badge.svg?branch=main)](https://github.com/radicle-dev/radicle-desktop/actions/workflows/lint.yaml) [![unit-test](https://github.com/radicle-dev/radicle-desktop/actions/workflows/unit-test.yaml/badge.svg?branch=main)](https://github.com/radicle-dev/radicle-desktop/actions/workflows/unit-test.yaml) [![e2e](https://github.com/radicle-dev/radicle-desktop/actions/workflows/e2e.yaml/badge.svg?branch=main)](https://github.com/radicle-dev/radicle-desktop/actions/workflows/e2e.yaml)
This desktop application lets you interact with [Radicle][rad], a peer-to-peer code collaboration and publishing stack.
## Installation
See [desktop.radicle.xyz/#install](https://desktop.radicle.xyz/#install).
### From source
**Prerequisites:**
- [Node.js][nod] (22.11.0 or higher) and [npm][npm]
- [Rust][rus] toolchain (1.77 or higher)
- [Tauri system dependencies][tau]
Run the following commands to build the desktop app locally:
```
git clone https://seed.radicle.xyz/z4D5UCArafTzTQpDZNQRuqswh3ury.git radicle-desktop
cd radicle-desktop
npm install
npm run tauri build
```
Then run one of the builds that the script outputs at the end.
## Development
To start the app in development mode with hot reload:
```
npm run dev
```
## Getting in touch
To get in touch with the maintainers, sign up to our [official chat on Zulip][zul].
## License
The UI is distributed under the terms of GPLv3. See [LICENSE][lic] for details.
[lic]: ./LICENSE
[rad]: https://radicle.xyz
[nod]: https://nodejs.org
[npm]: https://www.npmjs.com
[rus]: https://www.rust-lang.org/
[tau]: https://v2.tauri.app/start/prerequisites/#system-dependencies
[zul]: https://radicle.zulipchat.com/#narrow/stream/444463-desktop