Code Monkey home page Code Monkey logo

orkl's Introduction

orkl
Super simple peer-to-peer blogging site based on Beaker.

โ€•

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, 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) = 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
  • Navigate to 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": <directory of the content - required>,
  "title": <site title (overrides title in dat.json>,
  "style": <style object, set automatically>,
  "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, Jon Kyle (for Enoki and Dropout), Rasmus (for Inter UI) and the guys at Beaker.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.