English فارسی Suomi
Français Nederlands Translate

Booki

Booki: ContributingDev

Contributing to Code

Booki is Python based, built with the (bare) Django framework, and using JQuery for dynamic page elements. We will use Postgres as a database. The PDF generation will require the (headless) Mozilla Firefox as a rendering engine, with optional webkit rendering. Rendering of .odt will require OpenOffice to be installed with unoconv. The Web/IRC gateway will optionally require a standalone IRC service running locally. We will use the Xinha WYSIWYG editor, and XHTML as the file format for content. Content will be stored in GIT (some research required at this point). Pootle will be integrated into the core of Booki, and hence interface texts will be kept in Portable Object files (.po).

The code repository is GIT with a dedicated Trac for bug reporting and milestone tracking. The repository features Booki Core and extensions.

Each release will be as source. Beta and later releases will also be available as Debian .deb packages. User and API Documentation will be maintained in the FLOSS Manuals Booki Group. For development we will use Apache2 for http delivery, but other deployments can use any http service. 

Please join us in the development of Booki. I is a free software project, and you are welcome to contribute.

Below is some information about how to fund the development team, and where to look to get started.

IRC

you can find us often on irc :
server : freenode.net
channel :#flossmanuals

Email

We are a little old school and so we like to discuss things via email. If you would like to join the dicussion then please use this channel for all email communication :
http://lists.flossmanuals.net/listinfo.cgi/booki-dev-flossmanuals.net

Trac

For seeing the development milestones, bug tracking, logging issues, assigning development tasks etc please see the Booki trac :

http://booki-dev.flossmanuals.net/

Booki Demo

We run a demo of booki for development purposes online here :

http://booki-dev.flossmanuals.net:8080

Git

License

All development is GPL v2+ (we will not reply to discussions about licenses since it is a very very boring and distracting subject!)

Components

For the sake of making sure we are all talking the same language...there are three components :

  1. booki - manages user accounts, and this is where all the editing takes place
  2. objavi - the export engine
  3. espri - the import engine 

EDIT