Project structure

Project Structure

This document tries to give an overview about which module is supposed to contain what kind of functionality. Keep in mind: The structure of the Django project is not fixed, yet. Feel free to correct this overview in case something changed.

• volunteer_planner
  • accounts
  • blue_prints: Blue prints are some kind of template for shift planners. A blue print can be used to assign tasks (e.g. kitchen work) to different shifts (e.g. time slots) of the day and defining the amount of people who are needed for the task. The template can, then, be applied to different days (e.g. each Monday or for the whole week).
  • common: Common stuff like template filters.
  • google_tools: ???
  • locale: Configuration files for different languages.
  • notifications: Locations can publish messages. This module takes care of this.
  • registration: The registration form (also containing logic for actually activating the account).
  • requirements: Requirements contains different files listing dependencies that are needed to run the project in different environments (e.g. production or locally).
  • scheduler: The scheduler is the page you see after logging into the service. It lists all the locations and available jobs.
  • shiftmailer: The shiftmailer contains logic for distributing shift plans by mail.
  • stats: ???
  • templates: Contains templates that are common to all modules.
  • tests: ???
  • volunteer_planner: The project's main module containing settings.