|
53 | 53 | 4. In the .env file, configure the following environment variables for Twilio API, Slack Webhook, and Postgres URI. Refer to [Twilio](#-Twilio) setup section below. The Postgres URI is the only field that is required, others are optional.
|
54 | 54 | ```js
|
55 | 55 | // .env
|
56 |
| -TWILIO_NUMBER='' |
57 |
| -TWILIO_ACCOUNT_SID='' |
58 |
| -TWILIO_AUTH_TOKEN='' |
59 |
| -SERVICE_SID='' |
60 |
| -VERIFICATION_SERVICE_SID='' |
61 |
| -SLACK_WEBHOOK='' |
62 |
| -POSTGRES_URI='' |
| 56 | +TWILIO_NUMBER = '' |
| 57 | +TWILIO_ACCOUNT_SID = '' |
| 58 | +TWILIO_AUTH_TOKEN = '' |
| 59 | +SERVICE_SID = '' |
| 60 | +VERIFICATION_SERVICE_SID = '' |
| 61 | +SLACK_WEBHOOK = '' |
| 62 | +POSTGRES_URI = '' |
63 | 63 | ```
|
64 | 64 |
|
65 | 65 | 5. Create a folder called `security` in the project's top-level directory. Inside of the `security` folder, create two files `email.js` and `sysadmin.js`. These files will store variables related to the email notification service and system admin setup respectively.
|
@@ -112,13 +112,14 @@ To change the system admin password, create a new user with your preferred crede
|
112 | 112 | 2. In order to manage Twilio SMS notifications follow the [step plan](https://www.twilio.com/docs/notify/quickstart/sms#messagingservice).
|
113 | 113 | 3. Store your (i) Twilio number, (ii) Account Sid, (iii) Auth Token from twilio.com/console, (iv) SERVICE_SID, (v) verification service SID in a newly created .env file in the Docketeer folder in the following format:
|
114 | 114 | ```js
|
115 |
| - // .env.js |
116 |
| - MY_PHONE_NUMBER='your mobile number' |
117 |
| - TWILIO_ACCOUNT_SID='code from your console' |
118 |
| - TWILIO_AUTH_TOKEN='token from your console' |
119 |
| - SERVICE_SID='code from notify service instance' |
120 |
| - VERIFICATION_SERVICE_SID='code from verify service instance' |
121 |
| - ``` |
| 115 | +// .env.js |
| 116 | +MY_PHONE_NUMBER = 'your mobile number' |
| 117 | +TWILIO_ACCOUNT_SID = 'code from your console' |
| 118 | +TWILIO_AUTH_TOKEN = 'token from your console' |
| 119 | +SERVICE_SID = 'code from notify service instance' |
| 120 | +VERIFICATION_SERVICE_SID = 'code from verify service instance' |
| 121 | +``` |
| 122 | + |
122 | 123 | 4. Verification service was created [here](https://www.twilio.com/console/verify/services); code length and serviceSID can be taken from your Twilio account console.
|
123 | 124 | 5. All historical messages from the Twilio account can be found [here](https://www.twilio.com/console/sms/logs).
|
124 | 125 |
|
@@ -172,11 +173,11 @@ npm run test
|
172 | 173 | Read our [contributing guide](https://github.com/open-source-labs/Docketeer/blob/master/CONTRIBUTING.md) for more information on how to purpose bugfixes and improvements to Docketeer.
|
173 | 174 |
|
174 | 175 | ### Authors
|
175 |
| -- Abigail Gerig [@4estgirl] (https://github.com/4estgirl) | [Linkedin] (https://www.linkedin.com/in/abigail-gerig/) |
176 |
| -- Trine Medina [@TrineMedina] (https://github.com/TrineMedina) | [Linkedin] (https://www.linkedin.com/in/trinemedina/) |
177 |
| -- Christian Looff [@cmlooff] (https://github.com/cmlooff) | [LinkedIn] (https://www.linkedin.com/in/christian-looff/) |
178 |
| -- Reuel Warner-Rosen [@Ruliwr] (https://github.com/Ruliwr) | [Linkedin] (https://www.linkedin.com/in/Ruliwr/) |
179 |
| -- Matt Dias [@Schmang13] (https://github.com/Schmang13) | [Linkedin] (https://www.linkedin.com/in/matthew-j-dias/) |
| 176 | +- Abigail Gerig [@4estgirl](https://github.com/4estgirl) | [Linkedin](https://www.linkedin.com/in/abigail-gerig/) |
| 177 | +- Trine Medina [@TrineMedina](https://github.com/TrineMedina) | [Linkedin](https://www.linkedin.com/in/trinemedina/) |
| 178 | +- Christian Looff [@cmlooff](https://github.com/cmlooff) | [LinkedIn](https://www.linkedin.com/in/christian-looff/) |
| 179 | +- Reuel Warner-Rosen [@Ruliwr](https://github.com/Ruliwr) | [Linkedin](https://www.linkedin.com/in/Ruliwr/) |
| 180 | +- Matt Dias [@Schmang13](https://github.com/Schmang13) | [Linkedin](https://www.linkedin.com/in/matthew-j-dias/) |
180 | 181 | - Christina Son [@cson17](https://github.com/cson17) | [Linkedin](https://www.linkedin.com/in/christinason17/)
|
181 | 182 | - Fernando Luna [@lunaf-github](https://github.com/lunaf-github) | [Linkedin](https://www.linkedin.com/in/fernando-luna)
|
182 | 183 | - Austin Andrews [@austinandrews](https://github.com/austinandrews) | [Linkedin](https://www.linkedin.com/in/austinandrews17/)
|
|
0 commit comments