Important Notice
We intend to sunset the Programmable Chat API on July 25, 2022 to focus on the next generation of chat: the Twilio Conversations API. Find out about the EOL process. We have also prepared this Migration Guide to assist in the transition from Chat to Conversations.
Twilio Chat - Node
Node.js | Express implementation of Twilio Chat
Local Development
-
First clone this repository and
cd
into its directory:git clone https://github.com/TwilioDevEd/twiliochat-node.git \ cd twiliochat-node
-
Install project's dependencies:
npm install
-
Copy the sample configuration file and edit it to match your configuration.
cp .env.example .env
You can find your TWILIO_ACCOUNT_SID
in your
Twilio Account Settings.
For TWILIO_API_KEY
and TWILIO_API_SECRET
you need to go to
API Keys in the console. There
youl'll be able to create a new API key obtaining the two required values.
For TWILIO_CHAT_SERVICE_SID
you can go to the Programmable Chat dashboard,
where you must create a Chat Messaging Service. When the service is created you'll
have access to the service's SID.
-
Start the development server on
http://localhost:3000
npm start
Expose your localhost to the internet
If you want your chat application to be reachable publicly in the internet, you can use a service like ngrok.
-
Expose the application to the wider Internet
ngrok http 3000
Run the tests
-
Run backend tests
npm test
-
Run javascript tests:
cd public \ npm install \ npm test
Meta
- No warranty expressed or implied. Software is as is. Diggity.
- MIT License
- Lovingly crafted by Twilio Developer Education.