Skip to content
This repository was archived by the owner on Apr 21, 2021. It is now read-only.

Twilio Sync: Synchronize web and mobile apps with a single source of state in the cloud. Get started with Node.

License

Notifications You must be signed in to change notification settings

TwilioDevEd/sync-quickstart-node

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sync Quickstart for Node.js

This application should give you a ready-made starting point for writing your own real-time apps with Sync. Before we begin, we need to collect all the config values we need to run the application:

Config Value Description
Service Instance SID Like a database for your Sync data - generate one with the curl command below.
Account SID Your primary Twilio account identifier - find this in the console here.
API Key Used to authenticate - Use the IP Messaging dev tools to generate one here.
API Secret Used to authenticate - just like the above, you'll get one here.

Generating a Service Instance

During the Sync developer preview, you will need to generate Sync service instances via the REST API. This will eventually be replaced with a tool in the Twilio Console.

curl -X POST https://preview.twilio.com/Sync/Services \
 -d 'FriendlyName=MySyncServiceInstance' \
 -u 'SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_api_secret'

A Note on API Keys

When you generate an API key pair at the URLs above, your API Secret will only be shown once - make sure to save this in a secure location, or possibly your ~/.bash_profile.

Setting Up The Node.js Application

Create a configuration file for your application:

cp config.sample.js config.js

Edit config.js with the four configuration parameters we gathered from above.

Next, we need to install our dependencies from npm:

npm install

Now we should be all set! Run the application using the node command.

node .

Your application should now be running at http://localhost:4567. Open this page in a couple browsers or tabs, and start syncing!

License

MIT

About

Twilio Sync: Synchronize web and mobile apps with a single source of state in the cloud. Get started with Node.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5