Liberapay is a recurrent donations platform, trying to bring back the original spirit of Gittip that Gratipay has strayed away from.
Liberapay is a fork of Gratipay, so it's based on the web micro-framework Aspen. Aspen uses filesystem routing and simplates: to make Liberapay return a Hello $user, your id is $userid message for requests to the URL /$user/hello, you only need to create the file www/%username/hello.spt with this inside:
from liberapay.utils import get_participant
[---]
participant = get_participant(state)
[---] text/html
{{ _("Hello {0}, your id is {1}", request.path['username'], participant.id) }}
As illustrated by the last line our default template engine is Jinja.
The _ function attempts to translate the message into the user's language and escapes the variables properly (it knows that it's generating a message for an HTML page).
The python code inside simplates is only for request-specific logic, common backend code is in the liberapay/ directory.
We interact with the database by writing raw SQL queries sent via the postgres.py library.
Firstly, make sure you have the following dependencies installed:
- python 2.7 (a pull request to port to python 3 is very much welcome)
- virtualenv
- postgresql
- make
Then run:
make env
Now you'll need to create two postgres databases, here's the simplest way of doing it:
sudo -u postgres createuser --superuser $USER
createdb liberapay
createdb liberapay_tests
Then you can set up the DB:
make schema
Environment variables are used for configuration, the default values are in
defaults.env and tests/test.env. You can override them in
local.env and tests/local.env respectively.
Once you've installed everything and set up the database, you can run the app:
make run
It should now be accessible at http://localhost:8339/.
You can create some fake users to make it look more like the real site:
make data
The DB schema is in sql/schema.sql, but don't modify that file directly,
instead put the changes in sql/branch.sql. During deployment that script will
be run on the production DB and the changes will be merged into sql/schema.sql.
That process is semi-automated by release.sh.
The easiest way to run the test suite is:
make test
That recreates the test DB's schema and runs all the tests. To speed things up you can also use the following commands:
make pytestonly runs the python tests without recreating the test DBmake pytest-redoes the same but only runs the tests that failed in the previous run
Need some help? Open an issue or come ask your question in the IRC channel #liberapay on Freenode.