RSS Notification Service

The RSS Notification Service is currently a prototype for polling data sets (RSS feeds), polling pre-defined web pages, and sending emails based on changes automatically.

Requirements

RSS Notification Service requires the following:

• NodeJS
• NPM
• MailChimp API key
• An AWS account, specifically with SES and DynamoDB, with an AWS profile configured on your local machine

For local development, it is also useful to have:

• DynamoDB local
• DynamoDB admin

Setup

You will need to setup environment variables with your own details. The following are required:

export AWS_DYNAMODB_ENDPOINT=
export AWS_DYNAMODB_REGION=
export AWS_SES_ENDPOINT=
export AWS_SES_REGION=
export AWS_SES_FROM_EMAIL=
export MC_API_KEY=

Defaults:

AWS_DYNAMODB_ENDPOINT: http://localhost:8000
AWS_DYNAMODB_REGION: local
AWS_SES_ENDPOINT: http://localhost:9001
AWS_SES_REGION: local
AWS_SES_FROM_EMAIL: noreply@localhost

MC_API_KEY does not have a default and the application will fail if it tries to connect to MailChimp without an API key present.

Quick Start

git clone https://github.com/ukparliament/rss-notification-service.git
cd rss-notification-service
npm install && npm test
npm start

Contributing

If you wish to submit a bug fix or feature, you can create a pull request and it will be merged pending a code review.

1. Fork the repository
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Ensure your changes are tested using Mocha
6. Create a new Pull Request

License

RSS Notification Service is licensed under the MIT.