https://github.com/skzap/waka

Wiki engine with a peerjs/webrtc twist
https://github.com/skzap/waka

Last synced: 2 days ago
JSON representation

Wiki engine with a peerjs/webrtc twist

• Host: GitHub
• URL: https://github.com/skzap/waka
• Owner: skzap
• License: gpl-2.0
• Created: 2015-11-01T20:36:15.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-11-05T01:07:24.000Z (about 9 years ago)
• Last Synced: 2024-10-12T13:49:18.684Z (3 months ago)
• Language: JavaScript
• Homepage: http://wakapedia.info
• Size: 195 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Waka

This project's purpose is to create a wiki-style website with no server-side database, that can have loads of visitors with minimal server costs.

Articles are stored in the browser IndexedDB, then shared via peer-to-peer between users, without going through the server.

Demo: [Wakapedia.info](HTTP://WAKAPEDIA.INFO)

## Client (App.html)

#### Javascript Dependencies (CDN hosted)

* jquery

* peerjs: peer to peer in the browser

* idbstore: to store articles in the browser

* handlebars: html templating

* page.js: javascript router

* markdown-extra: syntax for articles

## Server.js

To get your own waka website running: 

    git clone https://github.com/skzap/waka.git

    npm install

Then add a file /js/public/config.js

    WakaConfig = {

    	PeerServer: {

          host: 'yourdomain.com', 

          port: 80, 

          path: '/peerjs',

          debug: true

    	},

    	PeerOptions: {

          debug: true,

          allow_discovery: true

    	}

    }

#### Dependencies

* peer: peer js signaling server

* express: http server to serve the html/js/css to client

* winston: logging