https://github.com/bolt04/client-connector

An application to contact users via SMS using Twilio APIs
https://github.com/bolt04/client-connector

sms twilio-apis typescript

Last synced: 13 days ago
JSON representation

An application to contact users via SMS using Twilio APIs

• Host: GitHub
• URL: https://github.com/bolt04/client-connector
• Owner: BOLT04
• License: mit
• Created: 2020-04-12T14:40:06.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-07-19T10:10:46.000Z (over 1 year ago)
• Last Synced: 2024-10-29T08:04:21.294Z (2 months ago)
• Topics: sms, twilio-apis, typescript
• Language: TypeScript
• Homepage: https://client-connector.herokuapp.com/
• Size: 4.1 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Client Connector

[![CodeQL](https://github.com/BOLT04/client-connector/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/BOLT04/client-connector/actions/workflows/codeql-analysis.yml)

![submission cover](/.github/submission-cover.PNG)

A web application to contact users via SMS using Twilio APIs

> :information_source: This project is for a hackathon submission. You can find the [announcement post](https://twil.io/dev-hack-april) and my [documented journey of this project](https://dev.to/bolt04/my-first-hackathon-141d) on [dev.to](https://dev.to/).

## Built with

- Node.js web server using [Express.js](https://npm.im/express) and [Typescript](https://www.typescriptlang.org/)

- [Programmable SMS Twilio API](https://www.twilio.com/docs/sms)

- React and Javascript for the client-side

- Deployed with [Heroku](https://www.heroku.com/). You can check out the live application [here](https://client-connector.herokuapp.com/)

## Features

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

## Set up

### Requirements

- [Node.js](https://nodejs.org/)

- A Twilio account - [sign up](https://www.twilio.com/try-twilio)

### 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](https://www.twilio.com/console).                                                         |

| TWILIO_AUTH_TOKEN   | Used to authenticate - [just like the above, you'll find this here](https://www.twilio.com/console).                                                         |

| TWILIO_FROM_PHONE_NUMBER | A Twilio phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164) - you can [get one here](https://www.twilio.com/console/phone-numbers/incoming) |

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

```bash

git clone https://github.com/BOLT04/client-connector.git

cd client-connector

```

2. Install dependencies

```bash

npm install

```

3. Run the application

```bash

npm start

```

5. Navigate to [http://localhost:3000](http://localhost:3000)

## License

[MIT](LICENSE)