source: Dev/branches/rest-dojo-ui/docs/README.txt @ 421

Last change on this file since 421 was 419, checked in by hendrikvanantwerpen, 12 years ago

Also update module ids and include README with file layout description.

File size: 2.2 KB
Line 
1===
2QED
3===
4
5File organisation
6-----------------
7client/
8  The web application for QED.
9  routes.js
10    Contains the mapping from URLs to pages.
11  run.js
12    The script for starting the web application (the researchers part).
13  stddeps.js
14    Contains many dependencies that are used declarativly in the
15    templates. Maybe it can be deprecated with Dojo 1.8+'s auto require
16    if the build scans templates as well.
17  store.js
18    Module that returns a fully configured store for the rest of the
19    application to use for database access. Handles caching and exposes
20    some common serialization functions.
21  view.js
22    Script that starts the survey part (the respondent part).
23  data/
24    Apache proxy configuration for transparant access to CouchDB.
25  dijit/
26    Dijit library (UI components)
27  dojo/
28    Dojo library (Dojo JS framework)
29  dojox/
30    DojoX library (contrib library for Dojo and Dijit)
31  qed/
32    Sourcecode of the QED application
33    app/
34      Small app framework for handling pages, content, notifications
35      and URL history. Our application is build on this.
36    css/
37      Contains all CSS of the application. Should be distributed better
38      with the widgets. The styling is based on LESS, although a copy
39      of the CSS is still there.
40    model/
41      Contains all code dependent on our model, that is, the concrete
42      representation of our database documents.
43      classes/
44        Smart classes on top of the database documents, to help with
45        creating and validating objects.
46      widgets/
47        All widgets that are specific for objects of our model.
48    pages/
49      The pages in the application. Are wired up to URLs in the routes.js
50      file.
51    store/
52      Dojo Store implementations for Couch and Elastic.
53    ui/
54      Deprecated. Used to contain all widgets, but these are now split
55      between general and model specific widgets. Contains a few widgets
56      that were not yet refactored.
57    widgets/
58      Contains general widgets that are used in our application but do
59      not depend on our model.
60  rx/
61    Rx.JS reactive framework for Javascript
62    rx.dojo.js
63      Custom file to integrate Rx with Dojo.
64  util/
65    Dojo utils (e.g. build infrastructure)
Note: See TracBrowser for help on using the repository browser.