Introduction

This repository is meant to showcase my talents as a back-end engineer to potential employers. It is programmed entirely in Node.js with Travis-CI for CI and Docker as its IAC.

Table of Contents

1. Problem statement
2. Methodology
3. Build
   • Prequesites
   • Local Development Environment
   • Environment Variables
   • Docker
4. Deploy
   • As Kubernetes Pod
   • As Docker Service
5. FAQ

Problem Statement

To create a HTTTP notification system. A server (or set of servers) will keep track of topics -> subscribers where a topic is a string and a subscriber is an HTTP endpoint. When a message is published on a topic, it should be forwarded to all subscriber endpoints.

Methodology

To see my thought process and all design decisions made, please check out the original proposal

Build

Prequesites

• Homebrew or APT
• NVM
• Docker Desktop
• VS Code

Local Development Environment

TODO

Environment Variables

NAME	TYPE	Default	Description
DB_URI	STR	-	Database URI connection string
BATCH_MAX_PUBLISH	NUM	10	Number of jobs a worker node can handle at a given time
PUBLISH_ATTEMPTS	NUM	10	Number of times to try to publish before giving up
SERVER_HOST	STR	localhost	Host to bind to
SERVER_PORT	NUM	3000	Port to bind to

Docker

TODO

Deploy

As Kubernetes Pod

TODO

As Docker Service

TODO

FAQ

Nothing to see here