61 lines
2.7 KiB
ReStructuredText
61 lines
2.7 KiB
ReStructuredText
Installing and integrating Registrasion
|
|
=======================================
|
|
|
|
Registrasion is a Django app. It does not provide any templates -- you'll need to develop these yourself. You can use the `registrasion-demo <https://github.com/chrisjrn/registrasion-demo>`_ project as a starting point.
|
|
|
|
To use Registrasion for your own conference, you'll need to do a small amount of configuration and development work, in your own Django App.
|
|
|
|
The configuration that you'll need to do is minimal. The first piece of development work is to define a model and form for your attendee profile, and the second is to implement a payment app.
|
|
|
|
|
|
Installing Registrasion
|
|
-----------------------
|
|
|
|
Registrasion depends on an in-development version of Symposion. You'll need to add the following two lines to your ``requirements.txt`` files::
|
|
|
|
git+https://github.com/pinax/symposion.git@ad81810
|
|
git+https://github.com/chrisjrn/registrasion.git@releases/0.1
|
|
|
|
Symposion currently specifies Django version 1.9.2.
|
|
|
|
Running ``pip install -r requirements.txt`` will pull down the git version of Symposion as well as the current 0.1 release of Registrasion.
|
|
|
|
|
|
Configuring your Django App
|
|
---------------------------
|
|
|
|
In your Django ``settings.py`` file, you'll need to add the following to your ``INSTALLED_APPS``::
|
|
|
|
"registrasion",
|
|
"nested_admin",
|
|
|
|
You will also need to configure ``symposion`` appropriately.
|
|
|
|
|
|
Attendee profile
|
|
----------------
|
|
|
|
.. automodule:: registrasion.models.people
|
|
|
|
Attendee profiles are where you ask for information such as what your attendee wants on their badge, and what the attendee's dietary and accessibility requirements are.
|
|
|
|
Because every conference is different, Registrasion lets you define your own attendee profile model, and your own form for requesting this information. The only requirement is that you derive your model from ``AttendeeProfileBase``.
|
|
|
|
.. autoclass :: AttendeeProfileBase
|
|
:members: name_field, invoice_recipient
|
|
|
|
Once you've subclassed ``AttendeeProfileBase``, you'll need to implement a form that lets attendees fill out their profile.
|
|
|
|
You specify how to find that form in your Django ``settings.py`` file::
|
|
|
|
ATTENDEE_PROFILE_FORM = "democon.forms.AttendeeProfileForm"
|
|
|
|
The only contract is that this form creates an instance of ``AttendeeProfileBase`` when saved, and that it can take an instance of your subclass on creation (so that your attendees can edit their profile).
|
|
|
|
|
|
Payments
|
|
--------
|
|
|
|
Registrasion does not implement its own credit card processing. You'll need to do that yourself. Registrasion *does* provide a mechanism for recording cheques and direct deposits, if you do end up taking registrations that way.
|
|
|
|
See :ref:`payments_and_refunds` for a guide on how to correctly implement payments.
|