{"id":19952861,"url":"https://github.com/ethersphere/swarm-desktop","last_synced_at":"2026-04-10T14:02:17.117Z","repository":{"id":36966647,"uuid":"465521639","full_name":"ethersphere/swarm-desktop","owner":"ethersphere","description":"Electron Desktop app that helps you easily spin up and manage Swarm node","archived":false,"fork":false,"pushed_at":"2025-03-12T15:29:26.000Z","size":22175,"stargazers_count":27,"open_issues_count":69,"forks_count":15,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-07T20:21:22.699Z","etag":null,"topics":["electron","ethereum","swarm"],"latest_commit_sha":null,"homepage":"https://desktop.ethswarm.org/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ethersphere.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-03T01:07:47.000Z","updated_at":"2025-03-12T15:17:26.000Z","dependencies_parsed_at":"2023-12-04T23:54:06.564Z","dependency_job_id":"10786e01-3cc1-4034-b011-93bd0273ddca","html_url":"https://github.com/ethersphere/swarm-desktop","commit_stats":null,"previous_names":[],"tags_count":80,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fswarm-desktop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fswarm-desktop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fswarm-desktop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fswarm-desktop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ethersphere","download_url":"https://codeload.github.com/ethersphere/swarm-desktop/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252241952,"owners_count":21717075,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["electron","ethereum","swarm"],"created_at":"2024-11-13T01:14:36.005Z","updated_at":"2026-04-10T14:02:17.086Z","avatar_url":"https://github.com/ethersphere.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Swarm Desktop\n\n[![Tests](https://github.com/ethersphere/swarm-desktop/actions/workflows/tests.yaml/badge.svg)](https://github.com/ethersphere/swarm-desktop/actions/workflows/tests.yaml)\n[![](https://img.shields.io/badge/made%20by-Swarm-blue.svg?style=flat-square)](https://swarm.ethereum.org/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)\n![](https://img.shields.io/badge/pnpm-%3E=10.0.0-orange.svg?style=flat-square)\n![](https://img.shields.io/badge/Node.js-%3E%3D14.0.0-orange.svg?style=flat-square)\n![](https://img.shields.io/badge/runs%20on-macOS%20%7C%20Linux%20%7C%20Windows-orange)\n\n\u003e Electron Desktop app that helps you easily spin up and manage Swarm's Bee node\n\n**Warning: This project is in beta state. There might (and most probably will) be changes in the future to its API and\nworking. Also, no guarantees can be made about its stability, efficiency, and security at this stage.**\n\nStay up to date by joining the [official Discord](https://discord.gg/GU22h2utj6) and by keeping an eye on the\n[releases tab](https://github.com/ethersphere/swarm-desktop/releases).\n\n## Table of Contents\n\n- [Install](#install)\n- [Usage](#usage)\n- [Contribute](#contribute)\n  - [Development](#development)\n  - [Test](#test)\n- [License](#license)\n\n## Install\n\nGo to the [releases page](https://github.com/ethersphere/swarm-desktop/releases/latest) and download the correct build for your operating system:\n\n- Windows: `Swarm.Desktop-***.Setup.exe`\n- macOS: `Swarm.Desktop-darwin-x64-***.zip`\n- Linux: `swarm-desktop_***_amd64.deb` or `swarm-desktop-***-1.x86_64.rpm`\n\n### macOS\n\nmacOS may not allow you to run the `.app` after unzipping. To solve this, right-click the `.app` and click Open. You will have an option to ignore the warning.\n\n## Usage\n\nTODO\n\n## Contribute\n\nThere are some ways you can make this module better:\n\n- Consult our [open issues](https://github.com/ethersphere/swarm-desktop/issues) and take on one of them\n- Help our tests reach 100% coverage!\n- Join us in our [Discord chat](https://discord.gg/wdghaQsGq5) in the #develop-on-swarm channel if you have questions or want to give feedback\n\n### Architecture\n\nSwarm Desktop consists of two components:\n\n1.  Electron back-end that provides orchestration API that retrieve, spins, stops and manage the Bee node\n2.  Bundled [Bee Dashboard](https://github.com/ethersphere/bee-dashboard) that provides UI to manage Bee node and provides access to Swarm network\n\nThe Electron back-end is placed in `src` folder.\n\nThe Bee Desktop stores logs of both itself and Bee in the application's logs folder:\n\n- macOS: `~/Library/Logs/Swarm Desktop/`\n- Windows: `%LOCALAPPDATA%\\Swarm Desktop\\Log\\` (for example, `C:\\Users\\USERNAME\\AppData\\Local\\Swarm Desktop\\Log\\`)\n- Linux: `~/.local/state/Swarm Desktop/`\n\nIt also stores configuration files, Bee assets and other things in application's data folder:\n\n- Windows: `%LOCALAPPDATA%\\Swarm Desktop\\Data` (for example, `C:\\Users\\USERNAME\\AppData\\Local\\Swarm Desktop\\Data`)\n- Mac OS: `~/Library/Application Support/Swarm Desktop`\n- Linux: `~/.local/share/Swarm Desktop` (or `$XDG_DATA_HOME/Swarm Desktop`)\n\n### Development\n\nAs there are several independent components it bit depends on what you want to develop.\n\n**Be aware!** The UI won't automatically open during development in order not to confuse on which environment they are running. You have to open them manually.\n\n#### Electron Desktop\n\nTo work on the Electron Desktop back-end you just need to do your work and then run `pnpm start`. This will launch the\nElectron app and shows the Tray icon. No UI will be opened automatically. If you need to make more adjustment you have\nto exit the process with `SIGINT (CTRL+C)` and relaunch.\n\n#### UI (Dashboard)\n\nTo work on the Dashboard, run first `pnpm start` that will spin up the Electron Desktop back-end. Then go to your\nlocally cloned `bee-dashboard` repo and in it start the development server with `pnpm start`. Dashboard also needs to\nhave API key injected in order to use the Desktop's API. You can inject it by running `pnpm run desktop` in the\nDashboard repo that will open the Dashboard UI with API key in the URL. Changes are automatically hot-reloaded.\n\nThe UI served by the Desktop itself is updated only when you update the `@ethersphere/bee-dashboard` NPM package in the\nDesktop repo.\n\n#### Maintenance tasks\n\nThere are several handy scripts:\n\n- `pnpm run init:husky` that initializes husky for commit linting\n- `pnpm run purge:data` that purges the Desktop's data folder\n- `pnpm run purge:logs` that purges the Desktop's logs folder\n\n## Maintainers\n\n- [Cafe137](https://github.com/Cafe137)\n- [vojtechsimetka](https://github.com/vojtechsimetka)\n\nSee what \"Maintainer\" means [here](https://github.com/ethersphere/repo-maintainer).\n\n## License\n\n[BSD-3-Clause](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethersphere%2Fswarm-desktop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fethersphere%2Fswarm-desktop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethersphere%2Fswarm-desktop/lists"}