Luke Plant avatar Luke Plant committed 3f7c60c

More help in the README

Comments (0)

Files changed (1)

   cciwmain.views uses forums.views.
 - test fixtures are re-used by different apps.
 
+
+Components
+----------
+
+The major components of the site are:
+
+1) Information about the camps that are run. This is all on publically
+   accessible parts of the site.
+
+2) Camp forums and photo galleries. Now largely unused. You have to log in
+   as a Member to post content.
+
+3) Booking - for campers (or their parents) to book places on camp and pay.
+
+4) Admin.
+
+   Used by a few people to add camp information, for example. Also used by
+   booking secretary to add/manage information about bookings, and various other
+   staff functions.
+
+
+5) Leaders and officers.
+
+   This contains utilities for leaders:
+
+   * to manage an officer list for their camp
+   * to view applications from officers
+   * to manage references for officers
+   * to download booking information about campers booked on the camp
+
+   ...and other things
+
+   It also contains utilities for officers to submit their application forms,
+   and helps for the booking secretary.
+
+   Where possible, the Django admin is used for some of these functions.
+
+
 Other notes
 -----------
 
 something and the equivalent CBV way, and you need to be comfortable with both
 styles.
 
+Login
+=====
+
+There are 3 separate login systems:
+
+* The standard django.contrib.auth.User system, used by the Django admin and the
+  officers section.
+
+* A custom login system for the camp forums, based on the Member model,
+  (very similar to contrib.auth.User, with passwords etc.)
+
+* A custom login system for booking places on camp, which is passwordless, based
+  on BookingAccount.
+
+
 Tests
 =====
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.