Skip to content

BOLT04/client-connector

Repository files navigation

Client Connector

CodeQL

submission cover

A web application to contact users via SMS using Twilio APIs

ℹ️ This project is for a hackathon submission. You can find the announcement post and my documented journey of this project on dev.to.

Built with

Features

  • Send a message to a person's phone using SMS

Set up

Requirements

Twilio Account Settings

This application uses the dotenv module to read the environement variables configuration. So in order to run the server, you must create a .env file and set the appropriate values to each variable. Below is a table with the variables you need to set, or check the file .env-sample (optional values aren't on the table):

Env Variable Description
TWILIO_ACCOUNT_SID Your primary Twilio account identifier - find this in the Console.
TWILIO_AUTH_TOKEN Used to authenticate - just like the above, you'll find this here.
TWILIO_FROM_PHONE_NUMBER A Twilio phone number in E.164 format - you can get one here

You can also set PORT to specify the port the server should listen to.

Local development

After the above requirements have been met:

  1. Clone this repository and cd into it
git clone https://github.com/BOLT04/client-connector.git
cd client-connector
  1. Install dependencies
npm install
  1. Run the application
npm start
  1. Navigate to http://localhost:3000

License

MIT