Changeset 464 for Dev/trunk/README.md

Timestamp:

06/23/13 21:46:11 (12 years ago)

Author:

hendrikvanantwerpen

Message:

Working deployment to Heroku.

File:

• Dev/trunk/README.md (moved) (moved from Dev/trunk/README.txt) (2 diffs)

Dev/trunk/README.md

@@ -1 @@
-===
-QED
-===
+# QED
 
-Install
--------
+This document describes how to develop this code base and the source
+code organisation.
 
-- Install CouchDB
-- Install Node.js
-- 
+## Development, Install and Deploy
 
+Source files are located in `src`. Build and deployment is managed
+with _Grunt_, a node based task runner.
+
+First make sure _node_, _npm_ and _couchdb_ are installed. Then
+install all dependencies by running `npm install`. To run _grunt_,
+you'll have to install the commandline client with `npm install -g
+grunt-cli`.
+
+From source to a deployable version goes in few steps.
+ 1. Develop in `src`.
+ 1. Create a development version with `grunt build`. This will put a
+    complete uncompressed version in `build/development`.
+ 1. Run the development version with `node server/standalone.js` or
+    `foreman start`. For the last option, you have to have the Heroku
+    chain installed.
+ 1. When editing more files, you can skip copying the fixed
+    dependencies and only process our own source files by running
+    `grunt compile`. If dependencies change (e.g. you installed node
+    modules) or you have the feeling something is weird, just do a
+    clean build by running `grunt build` again. Don't forget to
+    restart the server.
+ 1. When you feel your changes are production ready, create a
+    production version by running `grunt deploy`. This will do a
+    _Dojo_ build on the client, creating compressed CSS and
+    Javascript.
+ 1. You can test this version with the same commands as the
+    development version, but now from the `build/production`
+    directory. You can distribute the content is this directory as a
+    release.
+ 1. If you want to deploy to Heroku, do the following:
+    ```sh
+    $ git clone git@heroku.com:quod-erat.git build/quod-erat
+    $ cd build/quod-erat
+    $ rm -rf *
+    cp -r ../production/* .
+    git add .
+    git commit -a -m "Something informative goes here..."
+    git push
+    ```
 
 File organisation
 -----------------
+
+ * _/_ Project root
+   * _build/_ Builds go here
+     * _development/_ Uncompressed build
+     * _production/_ Minified build
+   * _docs/_ Project documentation, design documents etc
+   * _src/_ Source code
+     * _client/_ Dojo web client
+     * _server/_ Node/Express server
+     * _Procfile_ Heroku process description
+
+```
 client/
   The web application for QED.
@@ -66 +113 @@
       Contains general widgets that are used in our application but do
       not depend on our model.
-  rx/
-    Rx.JS reactive framework for Javascript
-    rx.dojo.js
-      Custom file to integrate Rx with Dojo.
   util/
     Dojo utils (e.g. build infrastructure)
+```