Skip to content

BigWhaleLabs/ketl-notifications-backend

Repository files navigation

Notifications backend for Ketl

Installation and local launch

  1. Clone this repo: git clone https://github.com/BigWhaleLabs/ketl-notifications-backend
  2. Launch the mongo database locally
  3. Obtain the necessary credentials:
  4. Create .env with the environment variables listed below
  5. Run yarn in the root folder
  6. Run yarn start

And you should be good to go! Feel free to fork and submit pull requests.

Environment variables

Name Description
MONGO URL of the mongo database
PORT Port to run server on (defaults to 1337)
APN_KEY_ID APN key ID for sending iOS notifications
APN_TEAM_ID APN team ID for sending iOS notifications
BUNDLE_ID Bundle ID for iOS notifications
ETH_RPC Ethereum RPC endpoint for notifications
ETH_NETWORK Ethereum network for notifications
NODE_ENV ENV of the project. Could be "development", "production" or "test"
IPFS_GATEWAY IPFS gateway for resolving content
HEALTHCHECK_WEBHOOK Webhook for healthcheck
KETL_VIEWS_BACKEND Backend, that counts post views
PASSWORD Password for protected routes
MIXPANEL_PROJECT_TOKEN Your Mixpanel project Token for

Also, please, consider looking at .env.sample.