@scaled-club/notifications

Notifications

This repository contains the code behind @scaled-club/notifications package which is responsible for creating a layer between our code and the notifications infrastructure (Firebase FCM & Redis).

Setup

After installing, you'll have to set up a new environment variable containing the base 64 encoded Firebase service account JSON and the Redis URL.

# .env

NOTIFICATIONS_REDIS_URL="redis://localhost:6379"

# During development and test, NOTIFICATIONS_ENABLED should be "false"
NOTIFICATIONS_ENABLED=true

# When NOTIFICATIONS_ENABLED=false, controls if tracking logs are displayed
NOTIFICATIONS_LOG=true

# Export the Google service account JSON and convert to Base64
NOTIFICATIONS_FIREBASE_SERVICE_ACCOUNT_BASE64=""

Publish new versions

• Change the package the way you want;
• Increase the package version with:
  • x.x.1: Patch version (bug fixes, adjustments)
  • x.1.x: Minor version (new feature, no changes on existing ones)
  • 1.x.x: Major version (breaking changes, must update host packages)
• Push the code to GitHub and create a release with the new package version