https://github.com/desmondsanctity/twilio-log-alert

An utility tool for incident/log alerts in Node.js APIs built with Winston and Twilio WhatsApp API
https://github.com/desmondsanctity/twilio-log-alert

Last synced: about 2 months ago
JSON representation

An utility tool for incident/log alerts in Node.js APIs built with Winston and Twilio WhatsApp API

• Host: GitHub
• URL: https://github.com/desmondsanctity/twilio-log-alert
• Owner: DesmondSanctity
• License: mit
• Created: 2023-09-26T17:46:00.000Z (about 1 year ago)
• Default Branch: APIs-only
• Last Pushed: 2023-11-01T15:41:37.000Z (about 1 year ago)
• Last Synced: 2024-05-30T02:18:00.029Z (7 months ago)
• Language: JavaScript
• Size: 49.8 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## twilio-log-alert

A utility tool for incident/log alerts in Node.js APIs built with Winston and Twilio WhatsApp API

## running the project

- Clone the repo to your local machine

  ```bash

  git clone https://github.com/DesmondSanctity/twilio-log-alert.git

  ```

- Run the installation command to install all the packages needed

  ```bash

  npm install

  ```

- Create a `.env` file and populate the following values with your values. The example `.env` is shown below:

  ```bash

  PORT=5000

  DB_NAME=XXXXX

  DB_USERNAME=XXXXX

  DB_PASSWORD=XXXXX

  DB_HOST=XXXXX

  JWT_SECRET=XXXXX

  JWT_EXPIRES_IN=XXXXX

  REDIS_URL=XXXXX

  ```

- Running the code below can generate a random 64-bit ASCII string that can be used for encrypting JWT tokens. After you run the code, copy the token as the value for `JWT_SECRET` in your  `.env` file;

  ```bash

  node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"

  ```

- The `JWT_EXPIRES_IN` variable in your `.env` file is used to moderate the time our JWT tokens will expire and users will have to log in again to use the APIs. In this tutorial, you will use `12h` as the value which signifies 12 hours.

- For DB credentials and Redis credentials, you will use your local DB credentials. This app uses MySQL as a database. You can easily set up one using XAMPP for general, WAMPP for Windows, or LAMPP for Linux. You can also install Redis locally and start the server. You might not need the `REDIS_URL` in this case. If you are using an external Redis cluster, you can then use the URL for the `REDIS_URL` value in your `.env` file.