emanguy / QuestTracker-NotificationService

Notification service for the homemade D&D quest tracker I'm making

Home Page:http://quest-tracker-by.evanrittenhou.se

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Quest Tracker Notification Service CircleCI

This Node.js server contains the code for pushing quest updates to clients. Upon visiting the page, the client will register with this server to receive quest update events and notifications.

It listens for several redis topics for new quests, quest updates, and quest removals before sending those events to connected clients.

Docker environment variables

  • PROCESS_PORT - the port to serve the node server on
  • REDIS_URL - The connection URL to the redis server which pushes quest update events
  • REDIS_PASSWORD - The password for the redis server we're connecting to
  • NODE_ENV - Standard node environment variable.

Local testing

The developer recommends setting up the Frontend API via the instructions there. That way all dependent services will already be set up. Be sure to make yourself a .env file to provide for any environment variables that the application complains about missing on startup.

Once the server starts up, go ahead and open sample.html. This page will continually write a list of received messages fron the push notification service and also display native notifications via the browser API. Messages should appear whenever a create, update, or delete operation occurs on a quest/objective on the Frontend API server.

About

Notification service for the homemade D&D quest tracker I'm making

http://quest-tracker-by.evanrittenhou.se

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:TypeScript 88.4%Language:HTML 9.6%Language:Dockerfile 2.0%