A next-generation modular web proxy platform built with Node.js, Express,
and advanced proxy backends.

---

Overview

SuperNova is a modern, extensible web proxy platform for unblocking and static site serving. It integrates multiple proxy backends (Ultraviolet, Scramjet, Bare, Epoxy, Libcurl, BareMux) and features a clean, responsive UI with built-in search and settings. Built for flexibility, speed, and ease of deployment.

---

Features

• Multi-Proxy Support: Ultraviolet, Scramjet, Bare, Epoxy, Libcurl, BareMux
• Dynamic Transport Switching: Switch between Wisp, Epoxy, and more
• Modern UI: Responsive interface with search and settings
• Static Asset Serving: Efficient HTML, JS, CSS, and service worker delivery
• API Endpoints: Autocomplete, version, and commit info
• WebSocket Upgrades: Wisp and Bare WebSocket support
• Modular & Extensible: Add new proxy backends or transports easily

---

Architecture

The main server (index.js) handles:

• Express routing and static asset serving
• Integration of all proxy backends
• API endpoints (/api/autocomplete, /api/version, /api/commit)
• WebSocket upgrades for Wisp and Bare
• Error handling and graceful shutdown

See docs/server-architecture-indexjs.md for a technical deep dive.

---

Prerequisites

• Node.js (v14.0.0 or higher) — Download Node.js
• npm or pnpm — Package manager (comes with Node.js)
• Git — Download Git

Installation & Usage

Using npm

git clone https://github.com/SuperNova-Network/SuperNova.git
cd SuperNova
npm install
npm start

Using pnpm (Recommended)

git clone https://github.com/SuperNova-Network/SuperNova.git
cd SuperNova
npm install -g pnpm # if not installed
pnpm install
pnpm start

Using Docker

git clone https://github.com/SuperNova-Network/SuperNova.git
cd SuperNova
docker build -t supernova .
docker run -p 8080:8080 supernova

After starting, open your browser and go to http://localhost:8080

---

Technologies Used

• Express.js — Web framework
• Ultraviolet — Proxy backend
• Scramjet — Proxy backend
• Bare Server — Proxy backend
• Wisp — WebSocket protocol
• Epoxy Transport — Alternative transport
• Bare-Mux — Transport multiplexer
• Libcurl Transport — Proxy transport
• Compression, dotenv, node-fetch, http-proxy

---

Contributing

Contributions are welcome! Please fork the repo, create a feature branch, and submit a Pull Request. See CODE_OF_CONDUCT before contributing.

---

Documentation & Support

• Documentation
• Server Architecture Deep Dive
• Proxy Backend & Service Worker Details

For help, open an issue or join the community.

---

Made with ❤ by the SuperNova Network team