Barely Functioning Wiki

wiki-like system for individuals and small teams, emphasizing micro-content and based on TiddlyWeb

Getting Started

• pip install tiddlywebplugins.bfw
• bfwinstance <instance directory>
• cd <instance directory>
• twanager server

For performance reasons, a dedicated web server (e.g. Apache, Nginx) is recommended - see apache.py and the assets section below.

Static Assets

It is generally preferable to have static files served by a web server (e.g. Apache, Nginx). Thus twanager assetcopy <target directory> can be used to copy BFW's assets into the respective directory where they can be served by the web server of choice.

Contributing

• install dependencies (optionally using virtualenv):

  $ pip install --use-mirrors \
      `python -c 'from setup import META; print " ".join(
          META["extras_require"]["testing"] +
          META["extras_require"]["build"] +
          META["extras_require"]["coverage"] +
          META["install_requires"])'`

• run tests: make test

• create a dev instance: make instance

• launch the server: make server (automatic reloading requires inotify)