Installation

This is a quick reference to get notifier up and running.

Requirements

To get started with notifier, you will need to have:

• A running instance of DemocracyOS (version 0.9.0 and above); so you got something to notify users about ;)
• A mandrill service instance.

Install

Unix and OS/X

• Fork or clone this repository.
• cd to the project's location
• Based on the files under the config directory, create a development.congig.js to create your own configuration file (i.e.: cp config/test.development.js config/development.config.js and set up your custom values).
• Make sure DemocracyOS' MongoDB is running and reachable as configured in config/development.config.js.
• From the root path, run make (where Makefile is located).

Windows

Not supported. Please address your complaints directly to Mr. Stallman.

Running a production environment

1. Configure your environment variables for production; specifically, set NODE_ENV to production
2. From the project's root path, you need to run:
3. npm install to install node dependencies.
4. node app.js to run the app.

If you're running other node services in the same server and you can't compromise NODE_PATH as an env variable, just prepend NODE_PATH=. to the make command.

Notes/troubleshooting

You can check the current Notifier version running on http://route-to-notifier/

If something goes wrong you can always go back to a clean slate running make clean.

For users behind a corporate proxy, it's recommended to redirect git clone to https (git config --global url."https://".insteadOf git://) and set properly http and https proxy env.

Finally, check your environment variables and read Environments and config files if something is not working properly.

Creating custom notifications

TBD