Skip to content
This repository has been archived by the owner on May 10, 2019. It is now read-only.

Commit

Permalink
suffix directories with / and add newlines, to match rest of doc
Browse files Browse the repository at this point in the history
  • Loading branch information
floatingatoll committed Apr 2, 2012
1 parent ed73fe0 commit 61d4c7e
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions docs/ORGANIZATION.md
Expand Up @@ -6,10 +6,12 @@ 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.
* `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
* `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.

Expand All @@ -19,24 +21,26 @@ and they share the following directory structure:
during the run (keys, logs, etc).

* `resources/`

* `views/` - Express views (server side), served before `static/` (if present)

* `static/` - Files served verbatim without any substitution nor server
side logic in them

* `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

* `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`

0 comments on commit 61d4c7e

Please sign in to comment.