diff --git a/docs/ORGANIZATION.md b/docs/ORGANIZATION.md index 15c2808f604fcc6c97c6dc38b6e6664383ef7ccf..1ea15477f120c7264da5fbfb800d114157e566d7 100644 --- a/docs/ORGANIZATION.md +++ b/docs/ORGANIZATION.md @@ -6,37 +6,37 @@ Several node.js servers are implemented in this repostiory, each is implemented on top of the [express](http://expressjs.com) framework and they share the following directory structure: - * `bin` - Contains the BrowserID servers (browserid, dbwriter, keysgner, and verifier) and CLI tools. - * Each node.js application is the "entry point" for that app and is a typical express app. +* `bin` - Contains the BrowserID servers (browserid, dbwriter, keysgner, and verifier) and CLI tools. + * Each node.js application is the "entry point" for that app and is a typical express app. - * `scripts` - Contains more CLI tools - * `run_locally.js` - Script to run all the node.js servers server - typically bound - against a well known localhost port. +* `scripts` - Contains more CLI tools + * `run_locally.js` - Script to run all the node.js servers server - typically bound + against a well known localhost port. - * `lib/` - Server side JavaScript modules +* `lib/` - Server side JavaScript modules - * `var/` - A demand created directory with ephemeral files generated - during the run (keys, logs, etc). +* `var/` - A demand created directory with ephemeral files generated + during the run (keys, logs, etc). - * `resources/` - * `views/` - Express views (server side), served before `static/` (if present) +* `resources/` + * `views/` - Express views (server side), served before `static/` (if present) - * `static/` - Files served verbatim without any substitution nor server - side logic in them + * `static/` - Files served verbatim without any substitution nor server + side logic in them - * `include.js` - The JS file included by all RPs. + * `include.js` - The JS file included by all RPs. - * `dialog` - The meat of the BID dialog, a client side MVC architecture with a state machine + * `dialog` - The meat of the BID dialog, a client side MVC architecture with a state machine - * `views/` - Client side EJS templates, not executed by ejs.js server side + * `views/` - Client side EJS templates, not executed by ejs.js server side - * `resources` - State machine and other logic powering the dialog + * `resources` - State machine and other logic powering the dialog - * `pages` - Client side business logic for dialog + * `pages` - Client side business logic for dialog - * `shared` - JavaScript which is re-used across dialogs + * `shared` - JavaScript which is re-used across dialogs - * `test` - QUnit tests + * `test` - QUnit tests - * `tests/` - Tests written using [vows](http://vowsjs.org) - * Run via `scripts/run_all_tests.sh` +* `tests/` - Tests written using [vows](http://vowsjs.org) + * Run via `scripts/run_all_tests.sh`