mirror of
https://github.com/PR0M3TH3AN/bitvid.git
synced 2025-09-05 05:38:41 +00:00
main
bitvid - Decentralized Video Sharing
IPNS: k51qzi5uqu5dgwr4oejq9rk41aoe9zcupenby6iqecsk5byc7rx48uecd133a1
bitvid is a decentralized platform where users can share videos and follow creators with privacy and freedom. Built with a static site architecture, it’s lightweight, efficient, and fully decentralized, making it ideal for hosting or local deployment.
Features
- Decentralized Sharing: Video sharing without central servers.
- Private Video Listings: Share encrypted videos for added privacy.
- Nostr Integration: Use Nostr keys for login and interaction.
- WebTorrent Streaming: Stream videos directly through torrent technology.
- Developer-Friendly: Open source and customizable for your needs.
- Responsive Design: Seamless experience across devices.
For Users
Getting Started
- Visit the Site: Navigate to the live instance of bitvid (e.g.,
[https://bitvid.network](https://bitvid.network)
). - Login with Nostr:
- Use a compatible Nostr browser extension or manually input your public key.
- Upload Videos:
- Provide a title, magnet link, and optional thumbnail or description.
- Toggle "Private" for encrypted listings.
- Stream Videos:
- Play videos directly in the browser using WebTorrent technology.
For Developers
Local Setup
To run bitvid locally:
-
Clone the repository:
git clone https://github.com/PR0M3TH3AN/bitvid.git cd bitvid
-
Start a local server:
- Using Python:
python -m http.server 8000
- Or with Node.js:
npx serve
- Using Python:
-
Open the site in your browser:
http://localhost:8000
Configuration
config.js
:- Toggle
isDevMode
for development (true
) or production (false
).
- Toggle
Adding Features
- Fork the repository and create a new branch for your feature.
- Make changes and test locally.
- Submit a pull request with a detailed explanation of your contribution.
For Contributors
How to Contribute
- Fork and Clone:
git clone https://github.com/PR0M3TH3AN/bitvid.git cd bitvid
- Create a Branch:
git checkout -b feature/your-feature-name
- Make Changes:
- Ensure your code follows best practices and is well-documented.
- Test:
- Validate the site functionality locally before submitting.
- Submit a Pull Request:
- Explain your changes and reference any related issues.
Contribution Guidelines
- Follow the MIT License.
- Use clear, concise commit messages.
- Respect the existing coding style and architecture.
Acknowledgments
bitvid leverages the following open-source technologies:
- Nostr Tools for decentralized identity management.
- WebTorrent for P2P video streaming.
- TailwindCSS for responsive design.
Contact & Support
- Website: bitvid.network
- GitHub: PR0M3TH3AN
- Nostr: npub13yarr7j6vjqjjkahd63dmr27curypehx45ucue286ac7sft27y0srnpmpe
Description
Languages
HTML
74%
JavaScript
25.1%
CSS
0.9%