Star 历史趋势
数据来源: GitHub API · 生成自 Stargazers.cn
README.md

🌉 ShareBridge

Simple. Fast. Cross-device file sharing.
Transfer files between devices without cables, complicated setup, or installing an application.

Live Demo GitHub

MIT License Web Platform In Development


📸 Preview

ShareBridge interface preview coming soon.


💡 What is ShareBridge?

ShareBridge is a browser-based file-sharing project designed to make transferring files between devices simple and convenient.

Whether you're using a Windows computer, Android phone, iPhone, or another supported device, ShareBridge aims to make sharing easier.

No complicated installation. No unnecessary accounts. Just open the website and connect your devices.

Our goal: Make file sharing as simple as opening a link.

✨ Features

FeatureDescription
🌐 Cross-deviceDesigned for computers, phones, and tablets
📱 QR pairingConnect devices using a QR code
⚡ Fast transfersDesigned around direct device-to-device communication
🔒 Privacy-focusedFile contents are intended to stay between connected devices
🖥️ Browser-basedNo dedicated application installation required
🎨 Modern interfaceClean, dark-themed user interface
🌍 Online accessConnect through the hosted website

🚀 Try ShareBridge

Live website:
https://gotkunal15.github.io/Sharebridge/

  1. Open ShareBridge on your first device.
  2. Generate a connection and display its QR code.
  3. Open ShareBridge on your second device.
  4. Scan the QR code to join the connection.
  5. Follow the on-screen instructions to share files.

⚙️ How It Works

ShareBridge uses a frontend website and a signalling backend to help devices establish a connection.

       DEVICE A                    DEVICE B
    ┌────────────┐              ┌────────────┐
    │  Browser   │              │  Browser   │
    └─────┬──────┘              └─────┬──────┘
          │                           │
          │       ShareBridge         │
          ├──────── Signalling ───────┤
          │                           │
          └──── Direct connection ────┘
                 (P2P design)

The signalling server helps devices exchange connection information. The intended architecture uses peer-to-peer communication for file transfer rather than storing file contents on the signalling server.

🧰 Technology Stack

TechnologyPurpose
HTML5Website structure
CSS3Interface and styling
JavaScriptApplication functionality
Node.jsBackend runtime
Express.jsHTTP server
WebSocketDevice signalling
WebRTCPeer-to-peer communication
QR CodeDevice pairing

🏗️ Project Structure

Sharebridge/
│
├── index.html
├── sharebridge.html
├── server.js
├── package.json
├── package-lock.json
├── README.md
├── LICENSE
│
└── .github/
    └── workflows/
        └── pages.yml

💻 Run Locally

Requirements

  • Node.js
  • npm
  • Git

1. Clone the repository

git clone https://github.com/gotkunal15/Sharebridge.git

2. Open the project folder

cd Sharebridge

3. Install dependencies

npm install

4. Start the server

node server.js

5. Open ShareBridge

Visit:

http://localhost:3000

The local server must remain running while using the local version.

🌍 Deployment

ShareBridge uses two hosted components:

ComponentPlatform
FrontendGitHub Pages
BackendRender

Frontend:
https://gotkunal15.github.io/Sharebridge/

Backend:
https://sharebridge-server-rgbs.onrender.com/

The GitHub Actions workflow deploys the frontend when changes are pushed to the main branch. The Render backend deploys from the repository separately.

🗺️ Roadmap

ShareBridge is an evolving project. Planned improvements include:

  • Faster and adaptive file transfers
  • Live transfer progress
  • Transfer speed and estimated time
  • Multiple-file sharing improvements
  • Drag-and-drop support
  • Better mobile experience
  • Large-file transfer optimisation
  • Transfer cancellation
  • Improved connection recovery
  • More detailed error messages

🤝 Contributing

Contributions, suggestions, and bug reports are welcome!

  1. Fork this repository.
  2. Create a feature branch.
  3. Make your changes.
  4. Commit your changes.
  5. Push your branch.
  6. Open a Pull Request.
git checkout -b feature/your-feature
git add .
git commit -m "Add your feature"
git push origin feature/your-feature

🐛 Report Issues

Found a bug or have an idea?

📄 License

ShareBridge is distributed under the MIT License.

See LICENSE for details.

👨‍💻 Creator

Kunal Dave

Created to explore better ways of connecting devices and sharing files.


If you find ShareBridge interesting, consider giving the repository a ⭐.

Built with curiosity. Connected with ShareBridge.

关于 About

ShareBridge - Transfer files between any device instantly. No cloud, no apps, just WiFi.

语言 Languages

HTML94.8%
JavaScript5.2%

提交活跃度 Commit Activity

代码提交热力图
过去 52 周的开发活跃度
13
Total Commits
峰值: 6次/周
Less
More

核心贡献者 Contributors