Bayjdo

A Fast, Simple & Secure Way to Transfer Files between Devices

🔥 Features

✅ Light - The lightest file-transfer app you would find!
✅ Fast - Zero Overheads. Theoretically, as fast as your WiFi is!
✅ Secure - P2P WebRTC-based File-Transfer
❌ No Special Hotspot - Works with any existing hotspot or network between devices.
❌ No App Install - Works on any device with a modern web browser.
❌ No Non-Sense - Open Source, No Ads, No User Info Asked/Stored

🎈 How to Use?

Ensure both devices are in the same network
Open Bayjdo in both devices, and from any one of the device enter the code of the other. (You may also make use of in-built QR-Scanner & Scan the QR instead)
Select files to send 🗂
Wait till transfer is complete, 🎉

💬 Frequently Asked Questions

What technology does it use?

The app is completely based on web-technologies and runs on any modern web browser. For establishing the connection between two devices, a WebRTC signalling server (PeerJS) is used. This server is however not involved in the data transfer process.

How is privacy ensured? 🙈

All files being transmitted get encrypted by WebRTC standards, no one except the two devices would be able to read them. For further clarification, no files are ever sent to any server, and the file are always transferred directly (P2P) from one device to another through an encrypted WebRTC/WS channel.

Are all browsers supported?

Sadly no. 😞 Only browsers with the support for WebRTC can support Bayjdo, however, all modern & popular browsers do support WebRTC and hence Bayjdo 🍻

🔧 Tech Stack

NextJS / PeerJS / WebRTC / WebSocket

💎 Contributions

Being an open source project, any sort of contributions - pull requests, bug reporting, feature request, documentation help are all welcomed.

🛠 How to Run Locally & Develop ?

To run and develop using docker-compose, you may use the following configuration in you docker-compose.yml -

version: '3.6'
services:
  bayjdo_server:
    container_name: bayjdo_server
    image: peerjs/peerjs-server
    ports:
      - 9000:9000
  bayjdo_webapp:
    container_name: bayjdo_webapp
    image: webapp
    ports:
      - 3000:3000
    environment:
      - PORT=3000
    volumes:
      - ./webapp:/app
      - /app/node_modules
      - /app/.next
    build:
      context: webapp
      dockerfile: Dockerfile-Dev
    command:
      "npm run dev"

🌟 How to Contribute?

Fork the repository, clone it locally and run it following the installation instruction above.
Find an issue or feature to work on, and put up an issue.
Work on the patch or feature, test it and send a pull request referencing the issue.

🛑 Disclaimer

This project is only being developed, as a hobby project and does not intend to replace any popular file transfer application. The implementation of this project is currently very basic, and intends only to be a proof of concept for the technology used. This app may have technical glitches, security & privacy vulnerabilities. If you plan to use it for transferring confidential files etc., please look elsewhere for now.

🐱 Inspirations

Neither the idea for this project, nor the technology used is, were conceived originally by me. This project only differs in implementations (+ some minor features), from some of the following popular projects it was inspired from -

✒️ License

This project repository is licensed under GNU General Public License V3.

Credits

Icons / illustrations - https://icons8.com/, https://icons8.com/ouch

Developed with ♥ by Ashwin Shenoy.

balgopalpatro / bayjdo Goto Github PK

bayjdo's Introduction