Development Quickstart

You want to work on Zine? Great. And here's how you do it.

Disclaimer: All Pocoo developers are either using Macs, Linux or BSD for their Zine development. If Windows' all you've got you will most likely need cygwin. If you want to help making developing on Windows easier contact us, maybe we can work something out.

First of all you have to decide which branch to work on. We have two active branches and you have to decide which one to work on:

• http://dev.pocoo.org/hg/zine-main -- the main repository for new features
• http://dev.pocoo.org/hg/zine-0.1 -- 0.1 maintenance branch for bugfixes and translations

If you have troubles selecting the correct branch, ask in the IRC Channel.

Check out the branch using hg:

$ hg clone http://dev.pocoo.org/hg/zine-0.1 zine

Afterwards step into the directory and initialize a new virtual environment:

$ cd zine
$ ./scripts/setup-virtualenv env

Now you have a virtual environment called "env" in the root of your repository initialized with all the libraries required for developing on that branch with the correct version.

Make sure to enable it before working on Zine:

$ source env/bin/activate

To start a local development instance of Zine:

$ mkdir instance && ./scripts/server -I instance

From here you can run the Zine setup in the browser at http://localhost:4000 (it usually simplest to use the sqlite database for local development).

To leave the virtual environment run this command:

$ deactivate

Check in often and merge often with upstream. When you're happy with the result, create a bundle or patch and attach it to a ticket in the trac.