dougshamoo/rmindr

Reminders for everyone, every way.

Rmindr

"Reminders for everyone every way"

Web App

rmindr.herokuapp.com

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Roadmap
4. Contributing

Usage

This web application will allow users to configure a wide variety of customizable reminders to be received at specified times in the future.

Requirements

• Node.js 4.2.1
• Express.js 4.13.3
• kue 0.10.4
• moment-timezone 0.4.1
• nodemailer 1.10.0
• Redis 3.0.5

Development

Installing Dependencies

From within the root directory:

npm install

Deployment

This project is deployed on Heroku, using Heroku Redis and kue.js to implement a priority job queue.

Roadmap

View the project roadmap here

Contributing

See our contribution guide for guidelines.

rmindr's Issues

(refactor) Move all server helper functions into helper file

(feat) implement email sender

(feat) Implement basic SMS sender

Twilio api

(feat) Add social media reminders

(bug) Fix `ERR max number of clients reached` issue when deployed

(doc) Update readme

(db) Add db for user credentials

(bug) Figure out why some emails are not processing on Heroku

I imagine this has to do with being on Heroku's free plan and dealing with shutdowns. However, the redis instance seems to be persisting and the clock process should process any missed emails after restarting. Might have to upgrade to hobby plan on Heroku before more meaningful testing can be done.

(bug)(deploy) Fix redis to go addon connection for heroku

• Check format of URL placed in config vars by redis to go heroku addon
• May have to parse url before creating the queue server-side

(refactor) Pull out kue options config to helper function

• replaces repetitive configuration in clock.js, routes.js
• makes it easier to switch out redis add-ons on heroku

(feat)(refactor) Add worker process, move work performed from clock to worker

Clock should only do scheduling, worker should perform send operations

(feat) implement simple clock process

kue.js and redis

(feat) deal with timezones before adding jobs to queue

Possible solutions

• Date.prototype.getTimezoneOffset on the client
• Moment timezone (?)
• Dropdown for user to select timezone (might be a good first step)

(feat) init basic express server

(feat) Add SMS reminder form to frontend

(feat)(refactor) Add angular or react frontend

(feat) Upload custom voice message as reminder

(deploy) Set up redis addon for heroku

(feat) implement phone call reminder

• Twilio API, can also use for sms reminder

(feat) Set up scheduling for SMS reminders

(feat) Add kue ui

For ease of development/testing, should be replaced later