From 500f4f3ca9189321ff12128302d635314d94add8 Mon Sep 17 00:00:00 2001 From: Anna Philips Date: Jun 07 2018 17:28:39 +0000 Subject: Updated README and dependency requirements --- diff --git a/README.md b/README.md index 06752fd..08daf0f 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,26 @@ # fedora-happiness-packets -This project conains the codebase for fedorahosted version of happinesspackets.io to be used during Appreciation week. +This project contains the codebase for fedora hosted version of happinesspackets.io to be used during Appreciation week. -Google Summer of Code Application Prerequisites for this projects are here: +# Setup -1. Create a FAS Id, join CommOps group +To run this project or the tests, you need to set up a virtualenv, install the dev requirements and set +the correct ``DJANGO_SETTINGS_MODULE``, for example with:: -2. Suscribe and send introductions to commops and summer-coding mailing lists. + virtualenv --no-site-packages --prompt='(happinesspackets)' virtualenv/ + source virtualenv/bin/activate + pip install -r requirements/dev.txt + export DJANGO_SETTINGS_MODULE=happinesspackets.settings.dev + ./manage.py collectstatic + python manage.py migrate + ./t -3. Ceate and share with us a Fedora wiki user page. For example, https://fedoraproject.org/wiki/User:Bee2502 +To run on http://127.0.0.1:8000/: -4. Follow the application process i.e create a subpage for your GSoC proposal and populate it with details. + python manage.py runserver -More info on that is here: https://docs.fedoraproject.org/mentored-projects/gsoc/2018/application.html +The ``t`` command is a very short shell script that runs the tests with the correct settings and reports on coverage. -Don't worry if you dont know everything i.e. the timeline. We can help you with that but fill as many details as you can. \ No newline at end of file +To run the integration tests:: + + ./manage.py test -v 2 -p integration_test*.py --settings=happinesspackets.settings.tsting diff --git a/requirements/base.txt b/requirements/base.txt index 971f15b..8295aa0 100644 --- a/requirements/base.txt +++ b/requirements/base.txt @@ -32,3 +32,5 @@ pep8==1.7.0 python-dateutil==2.5.0 factory-boy==2.9.2 opbeat==3.3 +mozilla-django-oidc==1.0.0 +fedmsg==1.1.1