You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-13
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ tc-notifications (as a standard nodejs app) provides generic framework around no
20
20
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.
21
21
22
22
## Dependencies
23
-
- 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 [email protected]` to support the gulp build)
23
+
- 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 [email protected]` to support the gulp build)
24
24
- Heroku Toolbelt https://toolbelt.heroku.com
25
25
- git
26
26
- PostgreSQL 9.5
@@ -50,8 +50,8 @@ The following parameters can be set in config files or in env variables:
50
50
if not provided, then SSL connection is not used, direct insecure connection is used;
51
51
if provided, it can be either path to private key file or private key content
52
52
-**Topcoder API**
53
-
-`TC_API_V3_BASE_URL`: the TopCoder API V3 base URL
54
-
-`TC_API_V4_BASE_URL`: the TopCoder API V4 base URL
53
+
-`TC_API_V3_BASE_URL`: the TopCoder API V3 base URL
54
+
-`TC_API_V4_BASE_URL`: the TopCoder API V4 base URL
55
55
-`TC_API_V5_BASE_URL`: the TopCoder API V5 base URL
56
56
-**Notifications API**
57
57
-`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:
61
61
-`TOKEN_CACHE_TIME`: time period of the cached token
62
62
-`AUTH0_CLIENT_ID`: auth0 client id
63
63
-`AUTH0_CLIENT_SECRET`: auth0 client secret
64
-
-`AUTH0_PROXY_SERVER_URL`: auth0 proxy server URL
65
-
-**Consumer handlers**
66
-
-`KAFKA_CONSUMER_HANDLERS`: mapping from consumer topic to handlers
67
-
-**Email notification**
68
-
-`ENV`: used to construct email category
69
-
-`ENABLE_EMAILS`: whether to enable email notifications
70
-
-`ENABLE_DEV_MODE`: whether to enable dev mode
71
-
-`DEV_MODE_EMAIL`: recipient email used in dev mode
72
-
-`DEFAULT_REPLY_EMAIL`: default reply email
73
-
64
+
-`AUTH0_PROXY_SERVER_URL`: auth0 proxy server URL
65
+
-**Consumer handlers**
66
+
-`KAFKA_CONSUMER_HANDLERS`: mapping from consumer topic to handlers
67
+
-**Email notification**
68
+
-`ENV`: used to construct email category
69
+
-`ENABLE_EMAILS`: whether to enable email notifications
70
+
-`ENABLE_DEV_MODE`: whether to enable dev mode
71
+
-`DEV_MODE_EMAIL`: recipient email used in dev mode
72
+
-`DEFAULT_REPLY_EMAIL`: default reply email
73
+
74
74
75
75
### Connect notification server
76
76
Configuration for the connect notification server is at `connect/config.js`.
@@ -137,6 +137,7 @@ You may reuse it during review.
137
137
- start local PostgreSQL db, create an empty database, update the config/default.js DATABASE_URL param to point to the db
138
138
- install dependencies `npm i`
139
139
- run code lint check `npm run lint`
140
+
- init DB `npm run reset:db`
140
141
- start connect notification server `npm start`
141
142
- the app is running at `http://localhost:4000`, it also starts Kafka consumer to listen for events and save unroll-ed notifications to db
0 commit comments