aboutsummaryrefslogtreecommitdiffstats
path: root/notes/code_structure.txt
blob: 310ffb19385aebfa0b71717f6c787d409cf3466f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
The code is broken down into the following sections:

* Website: code to display the website and handle user submissions

* Backend: send reports to the councils, work out who should get alerts,
  send questionnaires, and so on

* Mobile apps: currently for iPhone and Android - two separate apps, with
  a PhoneGap app being worked on.

* Utility scripts: odds and ends

Main top level directories
--------------------------

android     Native Android phone app source code
bin         Scripts, ranging from the ones that send reports to councils to
            one-offs to fix data import errors
commonlib   Shared mySociety functions
conf        Configuration file, needed Debian packages, example Apache config,
            and example crontab
db          Schema for PostgreSQL database
iphone      Native iPhone phone app source code
local       Local store of Perl modules
locale      Translation files
perllib     Source code of the FixMyStreet project
phonegap    PhoneGap mobile app, in progress
script      Catalyst management commands
t           Test suite
templates   Email and web templates
web         Front end static files; CSS, JS, images