Skip to content

Latest commit

 

History

History
185 lines (127 loc) · 8.29 KB

README.md

File metadata and controls

185 lines (127 loc) · 8.29 KB
Raw

Twilio Mixologist

About

Twilio Mixologist is an application that allows you to solve the problem of long queues at stands at events. Attendees can order their coffee, smoothie or whatever you serve via Twilio-powered channels, Mixologists get all orders on a website that can be accessed via a tablet and once an order is done the attendee will be notified via the system to come and pick it up. No more queueing and efficient coffee ☕️ ordering! 🎉

If you want to learn more about how this project was started, check out the this blog post:

Serving Coffee with Twilio Programmable SMS and React

Different versions of this system have been used at events such as:

Features

  • Receive orders using Twilio Messaging
  • Store orders and real-time synchronization them between back-end and front-end using Twilio Sync
  • Easy dynamic application configuration using Twilio Sync
  • Managing message threads using Twilio Conversations
  • Permission management based on Twilio Sync
  • Easy way to reset the application from the admin interface
  • Support multiple events that happen in parallel
  • Query for location in the queue as well as canceling the order as a user
  • All combined into a single NextJS web application

Pending Features

  • Integration with Segment
  • Your suggestions

Channels

The current Twilio Channels are:

Setup

Requirements

Setup

  1. Install the project's dependencies

    pnpm install

  2. Create a .env.local files with, at least, the following

    # Application related values
MIXOLOGIST_LOGIN=someuser:assword
ADMIN_LOGIN=someadmin:password
KIOSK_LOGIN=somekiosk:somepassword
SERVICE_INSTANCE_PREFIX=Mixologist
ACTIVE_CUSTOMERS_MAP=ActiveCustomers
UNLIMITED_ORDERS=CommaSeparatedNumbersToWhichTheLimitDoesNotApply

# NGROK URL GOES HERE
PUBLIC_BASE_URL=https://mobert.ngrok.io

# Twilio related values
TWILIO_ACCOUNT_SID=
TWILIO_API_KEY=
TWILIO_API_SECRET=

SEGMENT_SPACE_ID="your_segment_space_id"
SEGMENT_PROFILE_KEY="your_segment_profile_key"
SEGMENT_TRAIT_CHECK="your_segment_trait_check"

    Go into the Twilio Console and generate an API Key and Secret. Make sure to store the information safely.

  3. Run the setup script

    pnpm run create-twilio-res

  4. Now you can manually add all the senders you need to the Messaging Services that was just created for you. This can be done in the Twilio Console

  5. Go to the Verify service and make sure it is able to Send Email Verifications with Verify and Twilio SendGrid

  6. Connect your Messaging Service to your Conversation Service in the Twilio console.

    1. Turn on 'Handle Inbound Messages with Conversations' here
    2. Set your default Mesaging Service and Conversation Services to the Services created by the setup script
    3. Head back to your Messaging Service, navigate to 'Integration' and select 'Autocreate a Conversation' P.S. In the future this setup step will no longer be necessary

  7. Run the script to write the base config for the application. You can re-run this command whether you edit the configuration such as the menu (menus.ts) or the spelling map (spellingMap.ts). It will also pick up changes you're done to the sender pool of the messaging service.

    pnpm run update-config

  8. First, run the development server:

pnpm dev
  1. Open http://localhost:3000 with your browser to see the result.

How To Use

Here's a diagram of what happens when the user sends a message to the application

Testing

This projects comes with a test suit that runs on every push to main and feat/ branches. Unit tests cover basic capabilities (access control checks, template generator). And e2e tests cover the main functionality of the website since the data is loaded async and RSC's are currently not supported by unit test frameworks.

pnpm test # run unit tests
pnpm test:e2e # run e2e tests

Optional Setup

Tips for production

Here are a few helpful notes:

  • If you are using the SMS channel, make sure to set the SMS Geo Permissionsto make sure senders from the entire world can interact with the Mixologist.
  • Edit the opt-out management settings of the messaging service to avoid that users accidentally unsubscribe from the list.
  • Regularly run pnpm check-for-errors and see if unforeseen errors occurred when the users tried to order.
  • The Kiosk interface is a self-service interface that you can make available to attendees via a table or phone. The page allows the manual entry of an order without the need to put a phone number down. This form can be accessed via https://<mixologist.server>/<event-slug>/kiosk and the credentials are defined in the environment variable KIOSK_LOGIN.
  • Users can send the command "forget me" to remove all data stored about this user. It cancels pending orders, removes the user from the Sync data store and removes the Conversation resource. This can be used for debugging as well as to be GDPR-compliant.

Segment Integration

This project includes an optional integration with Segment's Profiles API. If you provide the SEGMENT_SPACE_ID and SEGMENT_PROFILE_KEY environment variables, the application will fetch user traits from Segment using the provided email address once the verification step is completed. The SEGMENT_TRAIT_CHECK environment variable allows you to specify a specific trait to check for in the user's profile.

To set up Segment integration:

  1. Create a Segment account if you don't have one. Sign up here.

  2. Create a Segment Space and obtain your SEGMENT_SPACE_ID.

  3. Generate a Segment Profile API Key and obtain your SEGMENT_PROFILE_KEY.

  4. Specify a Trait to Check by setting the SEGMENT_TRAIT_CHECK environment variable to the desired trait key.

For more details on Segment and how to use the Profiles API, refer to the Segment documentation.

Code of Conduct

Please be aware that this project has a Code of Conduct. The tldr; is to just be excellent to each other ❤️

Contributing to Twilio

All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under.

Icons Used

License

MIT