In this guide, we'll get you up and running with a sample application you can build on as you learn more about Sync.
Table Of Contents
- Gather account information
- Download and configure a starter app for your platform
- Explore the starter web/server app
The first thing to do is grab all the necessary information from your Twilio account. To set up your Sync token generator, we will need the following:
|Account SID||Your primary Twilio account identifier - find this on the main page of the Twilio console.|
|API Key||Used to sign tokens. Generate one using the console API Keys tool.|
|API Secret||Used to sign tokens, together with the corresponding API Key.|
Choose a download package for your server-side language of choice. If you're primarily a front-end developer and don't have a strong preference, Python, Node.js, or Ruby will probably get you up and running the fastest.
Follow the instructions in the README for each starter application to configure and run it on your machine, using the values above. You may ignore configuration values for other products; we'll focus on Sync for now.
This is where the fun begins! When you visit the homepage of the starter application, you should see a page which looks like this:
You have been assigned a random user identity and opened a Sync document called "SyncGame". If you open this page in another browser window or tab, you should be able to play an X or O on the board and see the game board replicate across the other tab.
- Fetch an
AccessTokenfrom the server via Ajax
- Open a Sync document called "sync.game".
- Handle UI events to update the document or refresh the document when other users make changes
Need some extra help? Send us a note at firstname.lastname@example.org, and we'll make sure to get you running just as quick as we can. Have fun building with Sync, and make sure to let us know what you're building!