Home

Welcome to the liberator wiki!

Here are some features we plan to support in the shortest time possible! :)

Liberator REST API

Liberator provides a REST API for writing frontends. Specification is still in the design phase but here's what we have for now. rest-api-v1

Etherpad doc is no longer valid. From now on, use API specification from this wiki. See pages linked below.

Current desing docs are here: https://etherpad.mozilla.org/TNO2UUGGGf

• /articles/
• /articles/:id
• /articles/:id/content
• /articles/:id/content/:id

API can be accessed on this URL: http://192.168.66.6:8080/api/v1

Automated Testing

We have 2 kinds of tests:

• functional tests
• unit tests

Functional tests are writen in the Gherking language and they are basically user stories. They can be run with Python Behave. Just enter the bdd dir and run behave. They consist of .feature files and steps. Steps are driving Firefox with Selenium web driver.

Unit tests are other kind of tests, which are run with Nose. Their main purpose for now is to test if REST API is working as expected. You can run them with ./manage.py test.

Feel free to write new tests or ask for any help on how to write them.

Apps Description

Apps are actually different perspectives for users which will be available through the libreoss/liberator-web-frontend.

Current mockups are here, and they are still under development. You can find them here: https://moqups.com/[email protected]/QAcmMVau

1. Article Archive
2. Create New Article
3. Edit Article Content
4. Liberator Dashboard
5. ...

Tools and versions

1. Django 1.7.x
2. Python 3.x
3. Vagrant 1.7.2
4. Virtualbox 4.3
5. Ansible 1.8.2

(This versions are tested and are working fine. Older may work, too... Find it out!)

Other features and dev guidelines

1. Full automated tests (TDD) - http://www.obeythetestinggoat.com/
2. Proper i18n with .po files - https://docs.djangoproject.com/en/1.7/topics/i18n/
3. Sync with legacy dokuwiki system - https://github.com/fantastic001/pydokuwiki
4. ...