From 0b14707683a4d679477031a5d80a0b61ad0f4c6c Mon Sep 17 00:00:00 2001 From: NoahMaizels Date: Thu, 28 May 2026 02:10:26 +0700 Subject: [PATCH] chore: fix awesome-list.mdx gitignore path and untrack generated file docs/references/awesome-list.mdx is auto-generated by scripts/fetch-awesome-swarm.mjs during the prebuild step and should not be tracked. The previous gitignore entry pointed to the wrong path (/src/pages/awesome-swarm.mdx). --- .gitignore | 2 +- docs/references/awesome-list.mdx | 154 ------------------------------- 2 files changed, 1 insertion(+), 155 deletions(-) delete mode 100644 docs/references/awesome-list.mdx diff --git a/.gitignore b/.gitignore index 0bda0de59..6b95e2adb 100644 --- a/.gitignore +++ b/.gitignore @@ -10,7 +10,7 @@ resources /src/pages/awesome-swarm.mdx /static/openapi.yaml test -/src/pages/awesome-swarm.mdx +docs/references/awesome-list.mdx *.zip *.csv link-reports/ diff --git a/docs/references/awesome-list.mdx b/docs/references/awesome-list.mdx deleted file mode 100644 index a0f502edf..000000000 --- a/docs/references/awesome-list.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: Awesome Swarm -sidebar_label: Awesome Swarm -description: Curated list of community resources tools and projects related to Swarm. -# Do NOT set 'id' here; we want the doc id to be 'references/awesome-list' from the path ---- - -*Contribute to the Awesome Swarm list on [GitHub](https://github.com/ethersphere/awesome-swarm).* - -[Swarm](https://www.ethswarm.org/) is an incentivized peer-to-peer storage and communication system. [Join the decentralized network with a Bee node](https://docs.ethswarm.org/docs/bee/installation/quick-start), the basic building block of Swarm. - -This is a list of free and open source projects related to Swarm and its growing ecosystem. - -See [CONTRIBUTING.md](https://github.com/ethersphere/awesome-swarm/blob/master/CONTRIBUTING.md) to learn how to create your submission. - -### Services - -**[`^ back to top ^`](#)** - -[Bee](https://github.com/ethersphere/bee) - Also referred to as the _node_ or the _client_, this service allows you to join the Swarm network. - - -### Libraries - -**[`^ back to top ^`](#)** - -[Bee-JS](https://github.com/ethersphere/bee-js) - A high-level Javascript library to interact with Bee through its REST API. - -[Mantaray-js](https://github.com/ethersphere/mantaray-js) - A low-level Swarm manifest manipulation library. - -[Mantaray-py](https://github.com/Ankvik-Tech-Labs/mantaray-py/) - Allows you to manipulate and interpret mantaray data via MantarayNode and MantarayFork abstractions. - -### CI/CD - -**[`^ back to top ^`](#)** - -[Beekeeper](https://github.com/ethersphere/beekeeper) - Orchestrate and test Bee clusters through Kubernetes. - -[Swarm Actions](https://github.com/ethersphere/swarm-actions) - GitHub Actions workflow for uploading data to the Swarm network. - -### UI - -**[`^ back to top ^`](#)** - -[Bee Dashboard](https://github.com/ethersphere/bee-dashboard) - React project to troubleshoot and interact with your Bee node. - -[Gateway](https://github.com/ethersphere/gateway) - Gateway to the Swarm project, for uploading, downloading and sharing assets on the network. - -[Swarmy](https://swarmy.cloud/) - Swarm as a service, makes it simple to store and retrieve data on Swarm. - -[Swarm Desktop App](https://www.ethswarm.org/build/desktop) - By running a lightweight Swarm node on your computer, you get direct access to the Swarm peer-to-peer network, without the need for centralized gateways. - -[Etherjot](https://github.com/ethersphere/etherjot) - Bring your web3 blog live in minutes with Etherjot, a graphical blogging application natively supporting Swarm. - -[buzzMint](https://buzzmint.io/) - A decentralised NFT creator. - - -### Tools - -**[`^ back to top ^`](#)** - -[Swarm MCP](https://github.com/ethersphere/swarm-mcp) - A Model Context Protocol (MCP) server implementation that uses Ethereum Swarm's Bee API for storing and retrieving data. - -[Swarm CLI](https://github.com/ethersphere/swarm-cli) - No more copy-pasting curl commands, with `swarm-cli` you can do everything on Swarm with simple commands straight from the terminal. - -[Swarm Extension](https://github.com/ethersphere/swarm-extension) - Official extension that adds Swarm support and injects Bee library to the browser. - -[Swarm CID Converter](https://github.com/agazso/swarm-cid-converter) - Convert Swarm hashes or links to CID and vice versa. - -[Bee-AFS](https://github.com/aloknerurkar/bee-afs) - FUSE filesystem for Bee. - -[Nextcloud Swarm Plugin](https://github.com/MetaProvide/nextcloud-swarm-plugin) - Plugin for bridging Nextcloud and Swarm. - -[Beest](https://github.com/w3rkspacelabs/beest) - An interactive CLI toolkit that simplifies the management of multiple Bee nodes. - -[Doctor Bee](https://github.com/w3rkspacelabs/doctor-bee) - A simple python script to check up a Bee node's health status. - -[IPFS to Swarm](https://github.com/Solar-Punk-Ltd/ipfs-to-swarm) - Migrate data from IPFS to Swarm. - -### Smart Contracts - -**[`^ back to top ^`](#)** - -[Swap, Swear and Swindle](https://github.com/ethersphere/swap-swear-and-swindle) - Protocols for peer-to-peer accounting. - -[Storage Incentives](https://github.com/ethersphere/storage-incentives) - Smart contracts providing the basis for Swarm's storage incentivization model. - -### Documentation - -**[`^ back to top ^`](#)** - -[The Book of Swarm](https://docs.ethswarm.org/the-book-of-swarm.pdf) - Storage and communication infrastructure for self-sovereign digital society back-end stack for the decentralised web. - -[Bee Docs](https://github.com/ethersphere/bee-docs) - Documentation for the Swarm Bee Client. View at [docs.ethswarm.org](https://docs.ethswarm.org/docs/). - -[Bee-JS Docs](https://github.com/ethersphere/bee-js-docs) - Documentation for the Swarm Bee-js javascript library. View at [bee-js.ethswarm.org](https://bee-js.ethswarm.org/docs/). - -[Swarm Specification](https://papers.ethswarm.org/p/swarm-protocol-spec/) - The Swarm specification document is an essential resource for developers and software engineers seeking to build their own Swarm client or integrate Swarm's functionalities into their applications. - -[Swarm Erasure Coding paper](https://papers.ethswarm.org/p/erasure/) - The erasure coding paper provides a technical exploration of erasure coding in the Swarm network, focusing on ensuring data integrity and resilience. - -[Swarm Papers](https://papers.ethswarm.org/) - Swarm’s documentation includes a variety of papers from technical specifications to in-depth explorations of the network's architecture and functionalities. - -[Bee API Reference](https://docs.ethswarm.org/api/) - Bee API Documentation. - - -### Community / Ecosystem - -**[`^ back to top ^`](#)** - -[Fair data society](https://fairdatasociety.org/) - Ecosystem initiative for ethical Web3. - -[FairOS](https://github.com/fairDataSociety/fairOS-dfs) - Distributed file system, key-value store and nosql store on Swarm (for developers). - -[The Fair Data Protocol (FDP)](https://fdp.fairdatasociety.org/) - A data interoperability protocol for dApps that use personal data. - -[FDP play](https://github.com/fairDataSociety/fdp-play) - CLI tool to spin up local development FDP environment and Bee cluster with Docker. - -[Fairdrive](https://fairdrive.fairdatasociety.org/) - Decentralised and unstoppable "Dropbox" for end-users and developers using Fair Data Protocol. - -[Fairdrive code](https://github.com/fairDataSociety/fairdrive-theapp) - Code for decentralised and unstoppable "Dropbox" for end-users and developers using Fair Data Protocol. - - -[SwarmScan](https://swarmscan.resenje.org/) - Get network insights. - -[Etherna.io](https://etherna.io/) - Decentralised media platform on Swarm. - -[SwarmNFT library](https://github.com/igar1991/SwarmNFT) - JavaScript library for creating NFTs on Ethereum-compatible blockchains and storing content on Swarm. - -[videoNFT](https://github.com/pabloVoorvaart/videoNFT/) - NFT live streaming with Swarm (winner of EthBerlin3 2022 Freedom to Transact Track). - -[DeBoot](https://github.com/awmacpherson/deboot) - DeBoot is a project to research and implement approaches to bootloading OS images from a decentralized storage network such as Swarm or IPFS. - -[Swarm DAppNode Package](https://github.com/rndlabs/dappnodepackage-swarm) - Swarm DAppNode package for Swarm Mainnet with multi-platform (x86_64 and arm64) support. - -[Mipasa Swarm Connector](https://github.com/MiPasa/mipasa-swarm-connector/) - MiPasa connector for Swarm (BZZ) distributed storage network. - -[Export Webpage on Swarm](https://github.com/ethersphere/devcon-swarm-exporter) - CLI tool to build an optimized static export of devcon app frontend. - -[Blob Storage on Swarm](https://github.com/Blobscan/blobscan) - The pioneer blockchain explorer dedicated to navigate and visualize shard blob transactions. - -[SWIPs](https://github.com/ethersphere/SWIPs) - The Swarm Improvement Proposal repository. - -### Miscellaneous - -**[`^ back to top ^`](#)** - -[Swarm Bot](https://github.com/ethersphere/swarm-bot) - Discord bot handling commands related to Swarm and its community. - -[ethersphere/bee DeepWiki](https://deepwiki.com/ethersphere/bee) - The DeepWiki for the Bee client GitHub repository. DeepWiki is a tool which provides autogenerated documentation (using LLM ai agents such as ChatGPT or Google Gemini) based directly on code from a GitHub repository. It also has a question box where any question can be asked about the Bee codebase. - - -*As with all LLMs, DeepWiki may sometimes be confidently wrong. Make sure to always double check (either by inspecting the code yourself, or confirming with a Bee team core developer) before assuming its answers are correct.* -