Booktype is a free, open source platform that produces beautiful, engaging books formatted for print, Amazon, iBooks and almost any ereader within minutes.
JavaScript Python HTML CSS Shell PHP CoffeeScript

README.md

Booktype

Booktype makes it easier for people and organisations to collate, organise, edit and publish books. Delivering frictionlessly to print, Amazon, lulu.com, iBooks and almost any ereader, Booktype facilitates collaborative production processes. No more lost manuscripts, overwritten Word files, awkward wikis or cumbersome CMSes.

Booktype is built on top of the Django web framework.

More info

Installation

Straightforward instructions to get you started on your first dev install of Booktype can be found on the Digital Ocean community tutorials site and provide a clear path to getting an install running on a Debian 8 machine.

Extra information can be found on the online instructions and in the Booktype manual.

How to contribute

Only 4 steps:

  1. Fork the sourcefabric/Booktype repository. Help or direct link.
  2. Clone your fork
  3. Create new local feature branch.
  4. Run tests.
  5. Create pull request with your feature/bugfix.

Testing

Booktype using py.test testing framework with pytest-django plugin, it makes testing process easier and also gives ability to run already created django (unittest) tests.

To run tests:

  1. Open terminal and activate virtual environment (Booktype must be installed).
  2. Go to (cd command) instance root (folder with manage.py and pytest.ini file).
  3. Run py.test command.
  4. If you want pytest to print test covarage information, you should run py.test --cov-report term-missing --cov=path/to/Booktype. You can read more about coverage here: pytest-cov

License

Booktype is licensed under the AGPL license.