README.rst

   1 Overview
   2 ========
   3
   4 This is a complete rewrite of the `Archlinux User Repository
   5 <http://aur.archlinux.org>`_ in Python/Django. It was created to improve the
   6 usability and usefulness of the AUR, and to make it more maintainable.
   7
   8 The purpose of this application is to provide a catalogue of Archlinux
   9 PKGBUILDs and binary packages. It allows user-contributed PKGBUILDs
  10 without any verification process, beyond that which can be performed
  11 automatically.
  12
  13 For more information about the development process see the `AUR 2 article on
  14 the Archlinux wiki <http://wiki.archlinux.org/index.php/AUR_2>`_
  15
  16
  17 Dependencies
  18 ============
  19
  20 * `Django <http://www.djangoproject.com>`_ >= 1.0
  21 * `django-registration <http://bitbucket.org/ubernostrum/django-registration>`_
  22 * `django-tagging <http://code.google.com/p/django-tagging>`_
  23
  24 If you use ``pip``, a ``pip-requirements.txt`` file is provided. It can be used as
  25 such::
  26
  27     pip install -r pip-requirements.txt
  28
  29
  30 Configuration
  31 =============
  32
  33 After all dependencies have been installed the ``settings_local.py``
  34 file should be configured, a prototype has been provided as
  35 ``settings_local.py.sample``. The default ``settings.py`` file has
  36 defaults targeted for a development environment. On a production system
  37 at least the settings in ``settings_local.py.sample`` should configured.
  38
  39 The *ADMIN_MEDIA_PREFIX* is only required if the admin app is used. It can be
  40 left as is, but MEDIA_URL would have to to be changed. The suggested
  41 configuration is to set it to ``/media/admin/`` and symlink that directory to the
  42 admin media directory (``django/contrib/admin/media``) in your Django
  43 installation.
  44
  45 A functioning email server is necessary for various parts of the application.
  46 The *EMAIL_HOST* and *EMAIL_PORT* settings should be configured appropriately.
  47 For development purposes, a dummy server can be used instead::
  48
  49     python -m smtpd -n -c DebuggingServer localhost:1025
  50
  51 At this point it would be a good idea to run all tests, to make sure everything works::
  52
  53     python manage.py test