From f8d38ff27431a0304294344781bd278f0f783438 Mon Sep 17 00:00:00 2001 From: sgm192425 <54698443+sgm192425@users.noreply.github.com> Date: Fri, 6 Sep 2019 21:28:16 +0530 Subject: [PATCH] Update README.md --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 808a611..47a64dc 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# TOPCODER NOTIFICATIONS +## TOPCODER NOTIFICATIONS ## Description This repository hosts the API and processors for enabling notifications in various topcoder apps. Currently it is limited to provide this facility to the [Connect](https://github.com/appirio-tech/connect-app) application. Theoretcially, it is a generic framework and application which could be used for sending and consuming notificaitons by any other topcoder app. In very simple words to send notifications using this application: @@ -20,7 +20,7 @@ tc-notifications (as a standard nodejs app) provides generic framework around no 5. Either add deployment for this new notification consumer/processor in existing deployment script (if you want to host the processor as separate service in the same ECS cluster) or write a new script if you want to keep the deployment separate. ## Dependencies -- nodejs https://nodejs.org/en/ (v6+, if newer version of node is used, e.g. v10, then it needs to install extra lib `npm i natives@1.1.6` to support the gulp build) +- nodejs https://nodejs.org/en/ (v6+, if newer version of node is used, e.g. v10, then it needs to install extra lib `npm i natives@1.1.6` to support the gulp build) - Heroku Toolbelt https://toolbelt.heroku.com - git - PostgreSQL 9.5 @@ -50,8 +50,8 @@ The following parameters can be set in config files or in env variables: if not provided, then SSL connection is not used, direct insecure connection is used; if provided, it can be either path to private key file or private key content - **Topcoder API** - - `TC_API_V3_BASE_URL`: the TopCoder API V3 base URL - - `TC_API_V4_BASE_URL`: the TopCoder API V4 base URL + - `TC_API_V3_BASE_URL`: the TopCoder API V3 base URL + - `TC_API_V4_BASE_URL`: the TopCoder API V4 base URL - `TC_API_V5_BASE_URL`: the TopCoder API V5 base URL - **Notifications API** - `API_CONTEXT_PATH`: path to serve API on @@ -61,16 +61,16 @@ The following parameters can be set in config files or in env variables: - `TOKEN_CACHE_TIME`: time period of the cached token - `AUTH0_CLIENT_ID`: auth0 client id - `AUTH0_CLIENT_SECRET`: auth0 client secret - - `AUTH0_PROXY_SERVER_URL`: auth0 proxy server URL -- **Consumer handlers** - - `KAFKA_CONSUMER_HANDLERS`: mapping from consumer topic to handlers -- **Email notification** - - `ENV`: used to construct email category - - `ENABLE_EMAILS`: whether to enable email notifications - - `ENABLE_DEV_MODE`: whether to enable dev mode - - `DEV_MODE_EMAIL`: recipient email used in dev mode - - `DEFAULT_REPLY_EMAIL`: default reply email - + - `AUTH0_PROXY_SERVER_URL`: auth0 proxy server URL +- **Consumer handlers** + - `KAFKA_CONSUMER_HANDLERS`: mapping from consumer topic to handlers +- **Email notification** + - `ENV`: used to construct email category + - `ENABLE_EMAILS`: whether to enable email notifications + - `ENABLE_DEV_MODE`: whether to enable dev mode + - `DEV_MODE_EMAIL`: recipient email used in dev mode + - `DEFAULT_REPLY_EMAIL`: default reply email + ### Connect notification server Configuration for the connect notification server is at `connect/config.js`.