Skip to content

Latest commit

 

History

History
98 lines (57 loc) · 3.79 KB

README.rst

File metadata and controls

98 lines (57 loc) · 3.79 KB

Lernanta

Lernanta is the new platform for P2PU. We are building on the codebase from Batucada, a rewrite of drumbeat.org by Mozilla.

Get Involved

To help out with Lernanta, join the P2PU dev mailing list and introduce yourself. We're currently looking for help from Django / Python and front-end (HTML, CSS, Javascript) developers.

Interested in getting involved in Lernanta code development? Check out the development wiki [0] for more info! For a broader view on the development and tech team at P2PU, check out the P2PU Development and Tech team [1] page on the P2PU wiki [2] .

[0] https://github.com/p2pu/lernanta/wiki [1] http://wiki.p2pu.org/w/page/31978748/Development-and-tech-team [2] http://wiki.p2pu.org

Setting up a local development environment

You will need to set up git and your SSH keys

You need a few libraries and can grab them with this command:

sudo apt-get install virtualenvwrapper libxml2-dev libxslt-dev mysql-client mysql-server libmysqlclient-dev python-dev

To install Lernanta, you must clone the repository:

git clone git://github.com/p2pu/lernanta.git

If you're planning on contributing back to the project, fork the repository instead in the usual GitHub fashion.

Next, you'll need to install virtualenv and pip if you don't already have them. Using virtualenvwrapper is also recommended.

sudo easy_install virtualenv
sudo easy_install pip
pip install virtualenvwrapper

Be sure to configure your shell so that pip knows where to find your virtual environments:

# in .bashrc or .bash_profile
export WORKON_HOME=$HOME/.virtualenvs
export PIP_VIRTUALENV_BASE=$WORKON_HOME
export PIP_RESPECT_VIRTUALENV=true
source /usr/local/bin/virtualenvwrapper.sh

Once installed, create your virtual environment for lernanta and install the dependencies. There's a chance that packages listed in requirements/compiled.txt won't install cleanly if your system is missing some key development libraries. For example, lxml requires libxml2-dev and libxslt-dev. These should be available from your system's package manager.

cd lernanta
mkvirtualenv --no-site-packages lernanta
workon lernanta
pip install -r requirements/compiled.txt
pip install -r requirements/prod.txt
pip install -r requirements/dev.txt

To be extra sure you're working from a clean slate, you might find it helps to delete .pyc files:

./rmpyc

If the mysql database doesn't exist yet, create it. You will use the database name, user, and password in the next file (settings_local.py)

mysqladmin -u <user> -p create <database name>

Create a settings_local.py based on the template provided in the checkout. Edit the database parameters as needed

cp settings_local.dist.py settings_local.py

Next, sync the database and run migrations.

python manage.py syncdb --noinput --migrate

Finally, start the development server to take it for a spin.

python manage.py runserver

To run the test framework.

python manage.py test

To recreate the test database before running the tests.

FORCE_DB=True python manage.py test

After updating a database model you will have to make a migration for the change. See the documentation for more information: https://github.com/p2pu/lernanta/blob/master/docs/migrations.txt

Once you have your development environment running, you can make changes or get the latest from github. See the wiki for more information: https://github.com/p2pu/lernanta/wiki