Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alexdlaird/twilio-taskrouter-demo

The TwilTwil project; ChaCha using Twilio's TaskRouter
https://github.com/alexdlaird/twilio-taskrouter-demo

aws-codedeploy bootstrap chacha django django-rest-framework education python taskrouter travis-ci twilio twilio-chat twilio-conversations twilio-sms twilio-voice

Last synced: 12 days ago
JSON representation

The TwilTwil project; ChaCha using Twilio's TaskRouter

Host: GitHub
URL: https://github.com/alexdlaird/twilio-taskrouter-demo
Owner: alexdlaird
License: mit
Created: 2018-03-08T00:03:48.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2024-10-21T10:12:34.000Z (18 days ago)
Last Synced: 2024-10-21T14:45:55.150Z (18 days ago)
Topics: aws-codedeploy, bootstrap, chacha, django, django-rest-framework, education, python, taskrouter, travis-ci, twilio, twilio-chat, twilio-conversations, twilio-sms, twilio-voice
Language: Python
Homepage: https://twiltwil.alexlaird.com
Size: 631 KB
Stars: 3
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

![Python Versions](https://img.shields.io/badge/python-%203.9%20|%203.10%20|%203.11%20-blue)
[![Coverage](https://img.shields.io/codecov/c/github/alexdlaird/twilio-taskrouter-demo)](https://codecov.io/gh/alexdlaird/twilio-taskrouter-demo)
[![Build](https://img.shields.io/github/actions/workflow/status/alexdlaird/twilio-taskrouter-demo/build.yml)](https://github.com/alexdlaird/twilio-taskrouter-demo/actions/workflows/build.yml)
![GitHub License](https://img.shields.io/github/license/alexdlaird/twilio-taskrouter-demo)

# TwilTwil

## Getting Started
The project is developed using Python and [Django](https://www.djangoproject.com).

This repository contains the source code for the TwilTwil project, ChaCha using [Twilio's TaskRouter](https://www.twilio.com/taskrouter).

### Project Setup

To setup the Python/Django build environment, execute:

```sh
make install
```

Create a Twilio account and purchase a phone number. You'll also need to generate a [Twilio API key](https://www.twilio.com/docs/iam/keys/api-key-resource).

Update the `.env` file and set the following variables:

* `TWILTWIL_TWILIO_ACCOUNT_SID`
* `TWILTWIL_TWILIO_AUTH_TOKEN`
* `TWILTWIL_TWILIO_PHONE_NUMBER`
* `TWILTWIL_TWILIO_API_KEY`
* `TWILTWIL_TWILIO_API_SECRET`

This project is configured to work with a Virtualenv which has now been setup in the `venv` folder. If you're
unfamiliar with how this works, [read up on Virtualenv here](https://virtualenv.pypa.io/en/stable). The short version
is, virtualenv creates isolated environments for each project's dependencies. To activate and use this environment when
developing, execute:

```sh
source venv/bin/activate
```

All commands below will now be run within the virtualenv (though `make` commands will always automatically enter the
virtualenv before executing).

To ensure the database is in sync with the latest schema, database migrations are generated and run with Django. To run migrations, execute:

```sh
make migrate
```

Once migrations have been run, you can create a super user, which is a standard user that also has access to the /admin site.

```sh
python manage.py createsuperuser
```

Now you're all set! To start the development server, execute:

```sh
bin/runserver
```

A development server will be started at .

If the `USE_NGROK` environment variable is set when a dev server is started (using `runserver`, [pyngrok](https://github.com/alexdlaird/pyngrok)
will be used to open a `ngrok` tunnel. This is especially useful when using webhooks.