bridgeswarm-website/README.md

BridgeSwarm Website

Official marketing site, user guide, and developer documentation for BridgeSwarm — a browser extension + native messaging host that bridges the Hyperswarm P2P stack into ordinary browsers.

Live at bridgeswarm.dev. Source code for the product itself lives at git.ssh.surf/snxraven/BridgeSwarm.

This repository is a static, multi-page site (Vite + vanilla HTML/CSS/JS — no framework, no client-side router). It is owned and published by HoneyPeer, LLC and licensed under AGPL-3.0 (see License).

Quick start

Requires Node.js 18+.

npm install     # install dependencies
npm run dev     # start the Vite dev server → http://localhost:5174
npm run build   # produce a static production build in dist/
npm start        # serve the production build → http://localhost:4174

Other scripts:

npm run preview  # Vite's own preview server for a local build (port 5174)
npm run serve     # alias for `npm start`

Script	Purpose	Port
npm run dev	Vite dev server with hot reload	5174
npm run build	Builds every page in vite.config.js into dist/	—
npm start / npm run serve	Serves dist/ via server.mjs (static files + generated sitemap.xml)	4174

server.mjs also proxies /api/releases to the Gitea releases API for the Releases page, and excludes noindex stub pages (like /legal/cookies) from the generated sitemap.

Content map

index.html            Marketing home page
download.html         Download / install instructions
releases.html         Release history (pulled from Gitea)
community.html        Community & support links
learn/                "How it works" walkthrough
use-cases/             Use case gallery

docs/                  Documentation
  index.html            Docs overview
  quickstart.html        Quick start guide
  user-guide.html        End-user guide (extension + host)
  developer-guide.html    Building on top of BridgeSwarm
  architecture.html       System architecture (extension ↔ host ↔ Hyperswarm)
  api.html                API reference
  data.html               Data API (Hypercore/Hyperbee/Hyperdrive/Autobase/Hyperdb)
  protocols.html          HRPC / protocol details
  capabilities.html       Capability packs (bare-media, bare-ffmpeg, etc.)
  examples.html           Example apps / local examples server
  security.html           Security model
  faq.html                FAQ
  release.html            Release channels & artifacts

legal/                 Legal hub — see below
  index.html              Overview of all policies
  terms.html              Terms of Service
  eula.html               End User License Agreement (extension + host)
  aup.html                Acceptable Use Policy
  privacy.html            Privacy Policy (local-first, no telemetry)
  cookies.html            Stub → redirects to /legal/privacy#cookies (noindex)
  license.html            AGPL-3.0 explainer, §13 network-use, source link
  copyright.html          Copyright & DMCA notice procedure
  disclaimer.html         "As-is" disclaimer & limitation of liability
  security.html           Vulnerability / responsible-disclosure policy

src/
  js/                   site.js (shared chrome/nav/footer/theme), home.js, releases.js
  styles/               global.css, docs.css, legal.css, home.css, theme-light.css

public/
  assets/
    brand/               OG/Twitter card images, hero backgrounds, brand colors.css
    favicons/             Favicons, site.webmanifest, browserconfig.xml
    logo/                 BridgeSwarm icon & wordmark, all sizes/variants
    social/               Social preview assets
  robots.txt

vite.config.js         Multi-page build config (all HTML entry points) + dev proxy
server.mjs              Production static server + sitemap generator

Every HTML page shares the same chrome, injected at runtime by src/js/site.js via data-nav / data-footer (and data-docs-nav / data-legal-nav for sidebar sections), so navigation, footer, and dark/light theme toggling stay consistent across the whole site without a build-time templating layer.

Brand assets

Logos, icons, wordmarks, and social card images live under public/assets/:

• public/assets/logo/ — BridgeSwarm icon & wordmark (light/dark/mono/teal variants, multiple sizes)
• public/assets/brand/ — OG/Twitter card images, hero backgrounds, and colors.css (brand color tokens)
• public/assets/favicons/ — favicons and PWA manifest

License & ownership

BridgeSwarm — the browser extension, the native messaging host, and this website's source — is owned, operated, and engineered by HoneyPeer, LLC (DeKalb County, Georgia, USA), and licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). See /legal/license for the full open-source notice, including AGPL §13 network-use obligations, and /legal/ for the complete set of legal policies (Terms, EULA, AUP, Privacy, Copyright/DMCA, Disclaimer, Security).

Legal contact: [email protected]