https://github.com/ryanoglesby08/the-eod-machine

:email: :earth_asia: Automate end-of-day update emails among distributed teams
https://github.com/ryanoglesby08/the-eod-machine

Last synced: 5 days ago
JSON representation

:email: :earth_asia: Automate end-of-day update emails among distributed teams

• Host: GitHub
• URL: https://github.com/ryanoglesby08/the-eod-machine
• Owner: ryanoglesby08
• Created: 2015-08-19T18:29:09.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2019-05-04T15:42:56.000Z (over 5 years ago)
• Last Synced: 2024-08-01T19:55:36.762Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 850 KB
• Stars: 8
• Watchers: 5
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# The EOD Machine

The EOD Machine makes is easy to share daily updates with remote or distributed team members. It is optimized for multi-site teams that have two co-located groups at separate locations, such as a team split between USA and India.

Each team member uses the EOD Machine web app on their own time to input information that they wish to share with the rest of the team. At pre-configured delivery times for each location, the EOD Machine will collate all entries and send an email to the team automatically.

Other options include [Status Hero](https://statushero.com/) or [Standuply](https://standuply.com/), but they are costly and proprietary. The EOD Machine will always be open source and free. :joy:

## Getting started

The EOD Machine is a web application with an email scheduler, distributed as a Docker image. You must provide a dedicated server on which to run it and an SMTP server to send the emails.

### Pre-requisites:

- [Docker](https://docs.docker.com/)

- SMTP server. [Gmail is an easy and free option](https://support.google.com/a/answer/176600?hl=en)

### Deployment

The EOD Machine application is composed of [3 docker images](https://hub.docker.com/r/ryanoglesby08/eod-machine/): a UI app server, an API, and a single-run emailer.

The easiest way of running everything is through the public `docker-compose` file, [available on Github](https://github.com/ryanoglesby08/the-eod-machine/blob/master/docker-compose.public.yml).

```bash

# Start mongo

docker-compose --file docker-compose.public.yml up --detach db

# Start the API on port 4000 and the UI on port 80

docker-compose --file docker-compose.public.yml up --detach ui api

```

The emailer is a single-run task, and should be run on a schedule using something like `cron`. Every 30 minutes is recommended.

```bash

0,30 * * * * /bin/bash -l -c docker-compose --file docker-compose.public.yml run \

  --env SMTP_HOST= \

  --env SMTP_PORT= \

  --env SMTP_USERNAME='' \

  --env SMTP_PASSWORD='' \

  emailer

```


## Local development

See the README.md file in each project directory (`api`, `ui`, and `emailer`) for getting started instructions.

Alternatively, you can run everything locally with `docker-compose`.

```bash

# Start the database first

docker-compose up --detach db

# Start the API and UI. Then open your browser to http://localhost:3000

docker-compose up --detach api ui

# Run the emailer as a one-off command

docker-compose run emailer

# Stop all services

docker-compose down

```