TZM Chapters code ::

Background

The Zeitgeist Movement Global Connect (ZMGC) aims to create an on-line eco-system within which the ideas of Resource Based Economy can be galvanise into actions that can be used in the real world.

It equips members with on-line tools, by providing the infrastructure necessary to easily exchange, analyse and disseminate information in a highly scalable and non-blocking manner using only Free Software build by the community.

Please refer to the wiki for deeper understanding of what this project is hoping to achieve. We also have a public trello board.

Setup

Before running this application we will need to setup couple of environmental settings, in order not to add any private data within the code.

Here is a list, that is currently used add these to your .zschrc or .bashrc :

|-------------------------------------------------------------------|
|Provider  |  Developer API Keys  |AuthID Providers    |SMTP Access |
|-------------------------------------------------------------------|
|Google    |  GOOGLE_API_KEY      |GG_APP_ID           |SMTP_USER   |
|          |                      |GG_APP_SEC          |SMTP_PASSWD |
|Facebook  |  FB_APP_ID           |*                   |            |
|          |  FB_APP_SEC          |*                   |            |
|Twitter   |                      |TT_APP_ID           |            |
|          |                      |TT_APP_SEC          |            |
|Yahoo     |                      |YH_APP_ID           |            |
|          |                      |YH_APP_SEC          |            |
|LinkedIn  |                      |LI_APP_ID           |            |
|          |                      |LI_APP_SEC          |            |
|Github    |                      |GITHUB_ID           |            |
|          |                      |GITHUB_SEC          |            |
|Trello    |  TRELLO_ID           |                    |            |
|          |  TRELLO_SECRET       |                    |            |
|-------------------------------------------------------------------|

Installation

After installing node.js, open terminal and navigate to your sandboxes folder

☺ git clone git://github.com/TZM/tzm-blade.git
☺ cd tzm-blade
☺ npm install

npm http GET https://registry.npmjs.org/express
npm http GET https://registry.npmjs.org/blade
....
☺ git submodule foreach git pull # to pull the translations

☺ cake dev
Server running at http://127.0.0.1:3000/

Now you can navigate to http://127.0.0.1:3000/ and see the website. (actually, on :3000)

Installation Screencast

Deployment

The application can be deployed anywhere where you have Nodejs installed, meaning that you can run this on your local machine and setup P2P; For now, this application is running on Heroku at zero cost, as Heroku provides you with a decent enough server to run this application.

To deploy on Heroku, you will need to first create an account and then setup your machine to talk to Heroku, see the Documentation, you will need to ensure to set the Environmental Variables as listed in the [Setup][#Setup] section.

Then from your console, you do this:

☺  git push heroku master
Fetching repository, done.
Counting objects: 5, done.
Delta compression using up to 2 threads.
Compressing objects: 100% (3/3), done.
Writing objects: 100% (3/3), 499 bytes, done.
Total 3 (delta 2), reused 0 (delta 0)

-----> Git submodules detected, installing
       Submodule 'locales/translations' (https://github.com/TZM/tzm-translations.git) registered for path     'locales/translations'
       Initialized empty Git repository in /tmp/build_512b4c08-b55a-4348-a891-934c9d565b14/locales/translations/.   git/
       Submodule path 'locales/translations': checked out 'ed50028edad99e5fe920e5791eb622efe49df266'
-----> Node.js app detected
        ...

       > node node_modules/coffee-script/bin/cake build

       ✓ Build complete, now run `cake dev`
       blade@3.3.0 node_modules/blade
       ├── commander@2.1.0
       └── uglify-js@2.4.12 (uglify-to-browserify@1.0.2, source-map@0.1.33, optimist@0.3.7)
-----> Caching node_modules directory for future builds
-----> Cleaning up node-gyp and npm artifacts
-----> Building runtime environment
-----> Discovering process types
       Procfile declares types -> web

-----> Compressing... done, 45.7MB
-----> Launching... done, v91
       http://serene-depths-3284.herokuapp.com deployed to Heroku

To git@heroku.com:serene-depths-3284.git
 + 0b13fdc...cfacabe master -> master

Once you have pushed to the remote heroku repository, you will need to create an admin user, you do this by executing the following command:

☺  heroku run cake --admin name@domain.tld --password P4SSWorD setup
Running `cake --admin name@domain.tld --password P4SSWorD setup` attached to terminal... up, run.1918
null
created uploads folder
mongodb://heroku_app:....mongolab.com:37358/heroku_app
creating user
user name@domain.tld is now admin: password set

Start databases

Currently we employ mongoDB to store the user data and Redis for sessions. We are currently working on migrating this to Riak, please follow the documentation for the secure deployment.

Mongo

☺  mongod                                                                                                                                                        ruby-2.0.0-p195""
Tue Jun 11 17:46:06.222 kern.sched unavailable
Tue Jun 11 17:46:06.234 [initandlisten] MongoDB starting : pid=19865 port=27017 dbpath=/usr/local/var/mongodb 64-bit host=aqoon.local
Tue Jun 11 17:46:06.234 [initandlisten] db version v2.4.1
Tue Jun 11 17:46:06.234 [initandlisten] git version: 1560959e9ce11a693be8b4d0d160d633eee75110
Tue Jun 11 17:46:06.234 [initandlisten] build info: Darwin bs-osx-106-x86-64-1.local 10.8.0 Darwin Kernel Version 10.8.0: Tue Jun  7 16:33:36 PDT 2011; root:xnu-1504.15.3~1/RELEASE_I386 i386 BOOST_LIB_VERSION=1_49
Tue Jun 11 17:46:06.234 [initandlisten] allocator: system
Tue Jun 11 17:46:06.234 [initandlisten] options: { bind_ip: "127.0.0.1", config: "/usr/local/etc/mongod.conf", dbpath: "/usr/local/var/mongodb" }
Tue Jun 11 17:46:06.246 [initandlisten] journal dir=/usr/local/var/mongodb/journal
Tue Jun 11 17:46:06.246 [initandlisten] recover : no journal files present, no recovery needed
Tue Jun 11 17:46:06.316 [websvr] admin web console waiting for connections on port 28017
Tue Jun 11 17:46:06.317 [initandlisten] waiting for connections on port 27017

Redis

☺  redis-server                                                                                                                                                  ruby-2.0.0-p195""
[98950] 11 Jun 16:35:25.877 # Warning: no config file specified, using the default config. In order to specify a config file use    redis-server /path/to/redis.conf  
[98950] 11 Jun 16:35:25.879 # Un    able to set the max number of files limit to 10032 (Invalid argument), setting the max clients    configuration to 8160.  
                _._   
           _.-``__    ''-._   
      _.-``    `.     `_.  ''-._           Redis 2.6.11 (00000000/0) 64 bit   
  .-`` .-```.  ```\   /    _.,_ ''-._   
 (    '      ,          .-`  | `,       )     Running in stand alone mode  
 |`-._`-...-` __...   -.``-._|'` _.-'   |     Port: 6379   
 |    `-._   `._       /     _.-'       |     PID: 98950   
  `-._    `-._  `-.   /  _.-'    _.-'   
 |`-._`-._    `-.__   .-'    _.-'_.-'   |  
 |    `-._`-._           _.-'_.-'       |           http://redis.io  
  `-._    `-._`-.__   .-'_.-'    _.-'   
 |`-._`-._    `-.__   .-'    _.-'_.-'   |  
 |    `-._`-._           _.-'_.-'       |  
  `-._    `-._`-.__   .-'_.-'    _.-'   
      `-._    `-.__   .-'    _.-'   
          `-._           _.-'   
              `-.__   .-'   

[98950] 11 Jun 16:35:25.880 # Server started, Redis version 2.6.11
[98950] 11 Jun 16:35:25.880 * The server is now ready to accept connections on port 6379

Development

To run locally for development use:

☺  cake dev
Watching coffee files
Watching js files and running server

DEBUG: Running node-supervisor with
....

Style Guide

ZMGC uses the CoffeeScript Style Guide with the following exceptions:

Indent 4 spaces
Maximum line length is 120 characters

When building with cake build or npm test you will see the output of CoffeeLint, a static analysis code quality tool for CoffeeScript. Please adhere to the warnings and errors to ensure your changes will build.

Unit Tests

Before submitting a pull request, please add any relevant tests and run them via:

npm test

If you have PhantomJS installed and on your path then you can use:

CI=true npm test

Pull requests will automatically be tested by Travis CI Node.js 0.8/0.10. Changes that cause tests to fail will not be accepted. New features should be tested to be accepted.

New tests can be added in the test directory.

Testing

The tests are now on Travis, for continuous integration see and to run localy you do:

 ☺  cake test
 Assetizing footer
 ...

   app
     ✓ should expose app settings

   sessions
     ✓ should be able to store sessions
     ✓ should be able to retrieve sessions

   3 tests complete (51 ms)

 ✓ Mocha tests complete

Directories

/assets : Stylesheets and Javascripts assets (coffee and less files) managed by the asset pipeline
/data : Data files used by D3, GeoLite and Node-Cldr
/docs : Various documentations and RFCs
/layout : Blade layouts
/locales : i18next locales
/public : All assets not managed by the asset pipeline (ex: images and vendor libaries)
/test/front-end : All Knockout application test files (managed by Jasmine)
/test/apps : All Express application test files (managed by Mocha)
/test/lib : All models libraries test files (managed by Mocha)
/test/models : All Express models test files (managed by Mocha)
/views : Blade views / pages

Stats

☺  cloc --exclude-dir=.app,buildAssets,data,public/css/font,public/css/fonts,public/css/vendor,public/js/vendor,node_modules .
  173 text files.
  169 unique files.
  13245 files ignored.

  http://cloc.sourceforge.net v 1.56  T=9.0 s (11.2 files/s, 1515.6 lines/s)
  -------------------------------------------------------------------------------
  Language                     files          blank        comment           code
  -------------------------------------------------------------------------------
  CSS                             13           1013            498           6783
  CoffeeScript                    41            453            788           2865
  Javascript                      42            110            226            802
  YAML                             1              0              4             27
  Bourne Shell                     1              0              0             19
  make                             1             12             13             18
  HTML                             2              3              0              6
  -------------------------------------------------------------------------------
  SUM:                           101           1591           1529          10520
  -------------------------------------------------------------------------------

Versioning

ZMGC will be maintained under the Semantic Versioning Guidelines as much as possible. Releases will be numbered with the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

Breaking backward compatibility bumps the major (and resets the minor and patch)
New additions, such as new functionality, without breaking backward compatibility bumps the minor (and resets the patch)
Bug fixes and miscellaneous changes will bump the patch number

For more information on SemVer, visit http://semver.org.

Todo

[ ] Mocha BDD api and frontend tests
[ ] Stylus css - update the css
[ ] Riak
- [ ] Riak cluster setup and deployment
- [ ] Riak administration
- [ ] Riak backup
[ ] DocPad integration - DocPad
[ ] AppFog Manifest for appfog deployment
[✓] ~~Heroku Procfile and instructions for [heroku deployment][https://github.com/TZM/tzm-blade#deployment]~~
[ ] Vagrant - create a dev environment with Riak cluster and and use the Chef provisioning tool to:
- [ ] install packages, riak, zmgc (node.js, express etc...) through npm
- [ ] create user accounts, as specified in included JSON config files
- [ ] setup riak
- [ ] configure firewalls
- etc...
Production hardening
- [ ] Cluster
- [ ] Error handling
- [ ] Monitoring
- [ ] Continuous Integration - [https://travis-ci.org/TZM/tzm-blade] ::
- [ ] Documentation

Benchmarks

See the Benchmark page for more information.

Warning

This application is still a work in progress and is not ready for use yet.

Get involved

The best way to get involved is to fork this project and submit pull requests or help with the functional and non-functional development, wireframes and writing of documentation.

We need javascript developers, specifically members who know Node.js, Express. Here is a list of how you may help:

Development - html5, javascript template development - see views/ and assets/ directory
Localization/Translation - we use the i18next library to localize and internationalize this application - see README.md in locales/ directory

TZM / tzm-blade

readme