1.2.0 • Published 6 months ago
peardeck v1.2.0
PearDeck: P2P Sharing App
Overview
PearDeck is a lightweight and innovative peer-to-peer sharing app that allows users to collaborate seamlessly without relying on centralized servers. With real-time sharing and robust privacy features, it's perfect for teams, educators, and remote workers looking for an efficient and secure way to exchange slides.
Features
- 📤 P2P File Sharing: Share directly with peers over a decentralized network.
- 📄 Live Slide Viewer: View shared in real-time within the app.
- 🛡️ Secure Connections: Built with hyperswarm and hypercore-crypto for encrypted data sharing.
- 🚀 No Central Server: Fully decentralized to prioritize privacy and eliminate server costs.
- 💡 User-Friendly Interface: Intuitive design for hassle-free usage.
Installation
Prerequisites
- Node.js (v16 or later)
- Git
Steps
- Install globally:
npm install peardeck -g
- Run:
peardeck
Usage
Create or Join a Room:
- Use the app to create a unique room or join an existing one using its hexadecimal ID.
Upload a Presentation:
- Click on "Upload Presentation" and select your file (PDF format).
Share & View:
- Share the presentation with peers and view it in the integrated viewer.
Technologies Used
- Frontend: HTML, CSS, JavaScript
- Backend: Node.js
- P2P Libraries: Hyperswarm, Hypercore-Crypto, b4a
Contributing
We welcome contributions to PearDeck! Here's how you can contribute:
1. Fork the repository.
2. Create a new branch for your feature or bug fix:
git checkout -b feature-name
- Commit your changes:
git commit -m "Add feature-name"
- Push the changes and submit a pull request:
git push origin feature-name
License
This project is licensed under the MIT License.
Contact
Have questions or suggestions? Reach out!
- Email: rohanchaudhary.bkbiet2022@gmail.com
- LinkedIn: (https://www.linkedin.com/in/rohan-chaudhary-399742255)
- GitHub Issues: Open an issue