https://github.com/kodedninja/orkl

Simple peer-to-peer blogging site
https://github.com/kodedninja/orkl

beaker blog dat p2p peer-to-peer

Last synced: 2 months ago
JSON representation

Simple peer-to-peer blogging site

• Host: GitHub
• URL: https://github.com/kodedninja/orkl
• Owner: kodedninja
• License: mit
• Created: 2018-02-27T19:01:19.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-11-06T19:48:49.000Z (about 6 years ago)
• Last Synced: 2024-11-04T02:32:55.623Z (2 months ago)
• Topics: beaker, blog, dat, p2p, peer-to-peer
• Language: JavaScript
• Homepage: https://orkl.seed.hex22.org/
• Size: 2.56 MB
• Stars: 54
• Watchers: 7
• Forks: 13
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - kodedninja/orkl - Simple peer-to-peer blogging site (p2p)

README

        
##### orkl

###### Super simple peer-to-peer blogging site based on [Beaker](https://beakerbrowser.com).

―

#### Why?

I wanted to build a peer-to-peer only blog; kind of like the p2p child of Svbtle and Telegra.ph. Fell in love with the idea of a site, which feels the same for the writer and the reader. The only difference is that the writer can change things and the reader can't. Thanks to [Dat](https://datproject.org/), we can easily decide if a computer is the owner or not of a site.

orkl is also 100% dynamic, so it's basically just a bunch of ```txt``` files (using [smarkt](https://github.com/jondashkyle/smarkt)) = no site generation or building.

#### Usage

The magic of Beaker Browser is the possibility to fork a site. To get started you can fork any orkl site, but for the sake of simplicity we will use an empty site I've made.

- Download [Beaker Browser](https://beakerbrowser.com)

- Navigate to [dat://orkl-kodedninja.hashbase.io](dat://orkl-kodedninja.hashbase.io)

- Find the "Fork this site" button, click it and fill out with your information

- Navigate to your site

- Edit the site's dat.json, adding `"fallback_page": "index.html"` (from Beaker 0.8 prerelease.1 this is not needed)

- Read the "How to use orkl?" entry

##### ```config.json```

```

{

  "directory": ,

  "title": ,

  "style": ,

  "nohttp": <if true, no content is rendered if accessed through http>

}

```

#### Development

Make a new site in Beaker then put the source code into it's directory. Run:

```

npm install

npm start

```

to start the bundler.

Thanks to [choo](https://choo.io), [Jon Kyle](https://jon-kyle.com) (for Enoki and Dropout), [Rasmus](https://rsms.me) (for [Inter UI](https://rsms.me/inter)) and the guys at Beaker.