Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bcastell/product-chat
Chatbot Dashboard
https://github.com/bcastell/product-chat
flask javascript mongodb python
Last synced: about 2 months ago
JSON representation
Chatbot Dashboard
- Host: GitHub
- URL: https://github.com/bcastell/product-chat
- Owner: bcastell
- License: mit
- Created: 2018-05-06T01:25:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T00:59:03.000Z (about 2 years ago)
- Last Synced: 2023-03-09T03:16:59.245Z (almost 2 years ago)
- Topics: flask, javascript, mongodb, python
- Language: HTML
- Homepage:
- Size: 940 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Product-Chat
Automate SMS responses to customer feedback using sentiment analysis
# Setup
Assumes a macOS environment.
## Dependencies
### Python
Install the latest versions of Python 2 and 3.
```bash
$ brew install python
$ brew install python3
```
### pip
Install pip.
```bash
$ sudo easy_install pip
```
### MongoDB
Install MongoDB.
```bash
$ brew install mongodb
```
If you're running El Capitan or earlier, execute this instead.
```bash
$ brew install [email protected]
```
Create the database directory. Give write permission to that directory.
```bash
$ sudo mkdir -p /data/db
$ sudo chmod -R go+w /data/db
```
### ngrok
Install ngrok.
```bash
$ brew cask install ngrok
```
### virtualenv
Prepare the virtual environment.
```bash
$ cd dashboard
$ virtualenv venv
$ . venv/bin/activate
```
### Python packages
Install Python packages.
```bash
$ pip install -r requirements.txt
```
-----------------------------------
## Run
### MongoDB
Run the mongod process in a separate terminal window.
```bash
$ /file/path/to/process/.../mongod
```
If you used brew to install MongoDB, the file path should be similar to the one below.
`/usr/local/Cellar/mongodb\@3.4/3.4.13/bin/mongod`
### ngrok
Run ngrok in a separate terminal window.
```bash
$ ngrok http 5000
```
### Twilio
1. Sign in to Twilio to access the dashboard
2. Navigate to Phone Numbers/Manage Numbers/Active Numbers
3. Select a phone number
4. Scroll down to the Messaging section
5. Locate the 'A MESSAGE COMES IN' field
6. Select Webhook in the left dropdown menu
7. Enter the HTTPS ngrok URL in the text field
8. Append `/sms` to the end of the URL
9. Select HTTP POST in the right dropdown menu
10. Save changes
### Environment Variables
Open `environ.sh` and enter values for the five soon-to-be environment variables.
```bash
export TWILIO_ACCOUNT_SID=
export TWILIO_AUTH_TOKEN=
export TWILIO_PHONE_NUMBER=
export TEXT_ANALYTICS_KEY=
export TEXT_ANALYTICS_SENTIMENT_URL=
```
Grant `environ.sh` write permission. Execute the file.
```bash
$ chmod u+x environ.sh
$ source environ.sh
```
### Flask
Start the local server in the same terminal window where `environ.sh` was executed.
```bash
$ flask run
```
Enter the URL `localhost:5000` in a browser.
When it's time to close the application, exit the virtual environment.
```bash
$ deactivate
```
-----------------------------------------------
## Usage
### Customer Phone Number
The customer phone number may be entered in various formats.
```bash
000-000-0000
000 000 0000
000.000.0000
(000)000-0000
(000)000 0000
(000)000.0000
(000) 000-0000
(000) 000 0000
(000) 000.0000
000-0000
000 0000
000.0000
0000000
0000000000
(000)0000000
```
### Tags
The tags `` and `` are replaced by the customer name and drink fields, respectively. All, some, or no tags can be included when editing messages.
### Form
* All form fields are validated before any SMS is sent to a customer.
* Customer name, phone number, and drink fields are cleared after a successful form submission. The message fields are preserved so the same messages can be quickly sent to another customer.