Skip to content

Directory Structure

ReubenRosenberg edited this page Oct 3, 2022 · 3 revisions

Within VenerableWebsite, there are the following directories:

  • database - contains SQL scripts for setting up the database, or filling it with test data
  • ruddock - contains the website proper
    • <files> - util functions, constants, etc
    • modules - most of the actual contents of the site
      • account - for creating accounts
      • admin - adding new users, office assignments, etc
      • auth - logging in, resetting passwords
      • government - officer lists
      • hassle - room hassle
      • rotation - prefrosh ranking stuff
      • users - user lists and profiles
    • static - CSS, Javascript, and other static content
    • templates - HTML pages for simple content like 404, index, contact us, info, etc.
    • testing - [TODO]
  • scripts - scripts for IMSS to run, rotation_setup, update_mail, etc.
  • tests - [TODO]

Within each module, we have subdirectories static and template, which contain CSS/JS content and HTML templates, respectively. See the Flask documentation for more on that.

Clone this wiki locally