https://github.com/silkroadnomad/orbit-blog

A library which provides react components to render orbit-db blog componenets and provides blog pinning service infrastructure
https://github.com/silkroadnomad/orbit-blog

blog decentralized orbit-db orbitdb

Last synced: about 1 year ago
JSON representation

A library which provides react components to render orbit-db blog componenets and provides blog pinning service infrastructure

• Host: GitHub
• URL: https://github.com/silkroadnomad/orbit-blog
• Owner: silkroadnomad
• License: mit
• Created: 2022-12-06T03:32:27.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-06T03:32:28.000Z (over 3 years ago)
• Last Synced: 2023-10-16T06:51:38.020Z (over 2 years ago)
• Topics: blog, decentralized, orbit-db, orbitdb
• Homepage:
• Size: 1.95 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

  

      

      
Orbit-Blog

      
A local-first & peer-to-peer blog powered by OrbitDB which replicates between browsers and mobile apps.

      

    

  


> ⚠️ **Alpha Version Notice**: This software is currently in alpha status and may change, break backwards compatibility, or contain major issues. It has not been security audited. Use accordingly.

## Description

Orbit-Blog is a decentralized blogging application that leverages OrbitDB for peer-to-peer data replication and IPFS for content storage. It enables users to create, manage, and share blog content in a decentralized manner, so blog posts are stored with the blog author and their readers maintain a replica via peer-to-peer connections.

## Installation

### As Progressive Web App (PWA)

Visit our IPNS link (requires [IPFS Companion](https://docs.ipfs.tech/install/ipfs-companion/)):

- IPNS: [ipns://k51qzi5uqu5djjnnjgtviql86f19isjyz6azhw48ovgn22m6otstezp2ngfs8g](https://k51qzi5uqu5djjnnjgtviql86f19isjyz6azhw48ovgn22m6otstezp2ngfs8g.ipns.dweb.link/)

[![QR Code to PWA](/public/ipns.dweb.link.png)](https://k51qzi5uqu5djjnnjgtviql86f19isjyz6azhw48ovgn22m6otstezp2ngfs8g.ipns.dweb.link/)

## Features

### Core Features

- ✅ Personal peer-to-peer blog creation

- ✅ Media storage inside a ad-hoc running IPFS node.

- ✅ Blog address sharing

- ✅ Blog subscriptions

- ✅ Identity management via 12-word encrypted seed (Metamask, Nostr coming soon) 

- ✅ Markdown support

- ✅ Post search

- ✅ Progressive Web App (PWA) support

### Technical Features

- ✅ OrbitDB replicates blogs to readers

- ✅ Temporary and persistent peer ID generation

- ✅ Blog deployed on IPFS 

- ✅ Internationalization (en, de, fr, es, it, ru, zh, ar, tr)

- ✅ URL hash routing for blog sharing

- ✅ LibP2P-Transport via secure Websocket, WebRTC and Webtransport

## Roadmap

### In Development

- Identity & Security

  - Metamask wallet integration

  - zkEmail-Integration for account recovery (under consideration)

  - write permissions for certain roles (One-Time Write Permission, Permanent Write Permission)

  

- Pinning Service Infrastructure 

  - Custom Voyager instance 

  - Voyager supports Pubsub peer discovery

  - Centralized Fiat+Crypto Pinning Gateway

  - Decentralized-Peer-to-Peer Voyager Network for OrbitDB Pinning

### Future Plans

- Advanced Data Management

  - Encrypted backups and restoration

  - Integration with FileCoin, ArWeave, Aleph-IM

- Content Features

  - Interactive blog posts with Svelte code execution

- DevOps

  - End-to-end testing

  - CI/CD pipeline with Docker

  - Automated IPFS publishing

## Contributing

This project is in active development. Contributions are welcome. Please check the issues page for current tasks and development priorities.

## License

This project is licensed under the MIT License.

## Contact

Visit us at [www.le-space.de](https://www.le-space.de)