Skip to content

Barely Functioning Wiki, emphasizing micro-content

Notifications You must be signed in to change notification settings

pads/tiddlywebplugins.bfw

 
 

Repository files navigation

Barely Functioning Wiki build status coverage

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

Getting Started

  • clone this repository
  • 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["install_requires"])'`
    
  • run tests: make test

  • create a dev instance: make instance

  • launch the server: make server

About

Barely Functioning Wiki, emphasizing micro-content

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 93.2%
  • JavaScript 3.3%
  • Shell 1.9%
  • CSS 1.6%