-
Notifications
You must be signed in to change notification settings - Fork 8
/
README.txt
80 lines (64 loc) · 2.28 KB
/
README.txt
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
OpenHDS
======
This project and variants of it are hosted on GitHub at the following URL:
* https://github.com/SwissTPH/openhds-server
Architecture
--------------------
OpenHDS is documented here:
* https://github.com/SwissTPH/openhds/blob/master/doc/OpenHDS_Manual.pdf?raw=true
A brief description of sub-components follows.
### Core components
controller:
Handles authentication, ID generation, services for updating the DB and
a few utilities.
Generation of external IDs can be custimized to improve human-readability.
domain:
A representation of the underlying data model (that used in the database).
dao:
Database Access Object: a proxy for all database reads/writes. Maps the
domain model to the database.
report:
Code for reports (the stuff under the "REPORTS" tab).
web:
Core web service (configuration, HTML). The web module also contains
Create, Read, Update, and Delete (CRUD) controllers for the web forms.
Also mentioned on the above wiki page is `Service`.
### Extensions
Extensions in their own directory:
community:
Exports death, pregnancy and population data according to the DHIS format.
ddi:
Exports and XML file describing the core data model according to the
Data Documentation Initiative.
dataextensions:
Generates code for handling extensions to the base DB schema.
datageneration:
Tool for generating test data. See "Instructions.txt" file for usage.
specialstudy:
Specific extensions (using dataextensions) for certain special studies.
Disabled by default.
task:
Some Java code for use with XML files, used by the web and webservice modules.
webservice:
Another web service? Mentioned in the wiki page graphic but not the text.
### Other directories
documentation:
Some documentation not intented to be "installed" with the web application.
mobile-forms:
Forms for ODKCollect.
Dependencies
--------------------
Maven plugins (i.e. dependencies affecting the build process):
* Maven compiler
* Maven JAR plugin
* Maven WAR plugin
* Maven Surefire plugin
* Maven Assembly plugin
* Maven deploy plugin
* Maven Eclipse plugin
* Maven release plugin
* Maven source plugin
* Tomcat
* Jetty
* XMLBeans Maven plugin (ddi and community modules)
* aspectj (only optional specialstudy module)