From 90100e2cb6804e3e3ad8b709fa65b13523dd943c Mon Sep 17 00:00:00 2001 From: Peter van Hardenberg Date: Fri, 16 Dec 2016 09:20:56 +0000 Subject: [PATCH] Add a README describing basic setup etc. --- README | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..9308490 --- /dev/null +++ b/README @@ -0,0 +1,39 @@ +# CommitFest + +This application manages commitfests for the PostgreSQL community. + +A commitfest is a collection of patches and reviews for a project and is part of the PostgreSQL development process. + +## The Application + +This is a Django 1.8 application backed by PostgreSQL and running on Python 2.7. + +## Getting Started + +### Ubuntu instructions + +First, prepare your development environment by installing pip, virtualenv, and postgresql-server-dev-X.Y. + +$ sudo apt install python-pip postgresql-server-dev-9.6 + +$ pip install virtualenv + +Next, configure your local environment with virtualenv and install local dependencies. + +$ virtualenv env +$ source env/bin/activate +$ pip install -r requirements.txt +$ python manage.py migrate + +Now prepare the application to run locally. + +First disable the PostgreSQL.org authentication modules by removing the `AUTHENTICATION_BACKENDS` list in pgcommitfest/settings.py. Authentication will default to the built-in Django authentication module. While you're modifying settings.py, set `DEBUG = True` to enable more debugging information. + +You'll need either a database dump of the actual server's data or else to create a superuser: + +$ python manage.py createsuperuser + +Finally, you're ready to start the application: + +$ python manage.py runserver + -- 2.39.5