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