istefanov/wiki

Federated Wiki client and server in Node.js

Wiki

Wiki is a single-page application for browsing and editing content distributed throughout a federation of similar creative-commons licensed sites. What is a federated wiki, and why does federation matter? Authors thoughout the federation pull content towards themselves as they edit. With this package authors publish their own edits back to the federation as they edit.

Over the past two years, the Smallest Federated Wiki project has explored the concept and implementation details of the federated wiki concept. This code has been extracted from that project, with the goal of releasing a polished, easy to deploy package.

Using Federated Wiki

Learn how to wiki by reading fed.wiki.org

Running your own Server

The quickest way to set up wiki on your local machine is to install it globally with npm:

$ npm install -g wiki
$ wiki

Visit localhost:3000 to see your wiki. If you choose a host visible to the internet then other in the federation can use your work.

Server Options

Options for the server can be passed in many ways:

• As command line flags
• As a configuration JSON file specified with --config
• As a config.json file in the root folder or cwd.
• As env vars prefixed with wiki_

Higher in the list takes precedence. The server will then try to guess all unspecified options.

You can also switch datastores to leveldb from flatfiles by switching require('./page') to require('./leveldb') in lib/server.js.

Developing Wiki

This package consists of client and server code as well as a number of sample plugins that create special purpose markups that can be used on a paragraph by paragraph basis. Get the code, build the client, and start the server:

$ git clone https://github.com/WardCunningham/wiki.git
$ cd wiki
$ grunt build
$ npm start

While you're coding, you can also watch for files to change. This will rebuild the client each time you save a file.

$ grunt watch

Test the server-side code by running $ grunt test.

Test the client-side code by starting your wiki server with $npm start and opening http://localhost:3000/runtests.html

How to Participate

• Join the developer IRC channel, #fedwiki on freenode
• Stop by the Google Hangout at 10am Pacific every Wednesday
• Submit Issues
• Fork, commit and submit Pull Requests

License

You may use the Wiki under either the MIT License or the GNU General Public License (GPL) Version 2.