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 Values | Description |
---|---|
Service Instance SID | A service instance where all the data for our application is stored and scoped. Generate one using the command below. |
Account SID | Your primary Twilio account identifier - find this in the console here. |
API Key | Used to authenticate - generate one here in the console. |
API Secret | Used to authenticate - just like the above, you can use the console to generate one here. |
During the Sync developer preview, you will need to generate Sync service instances via API until the Console GUI is available. Using the API key pair you generated above, generate a service instance via REST API with this command:
curl -X POST https://preview.twilio.com/Sync/Services \
-d 'FriendlyName=MySyncServiceInstance' \
-u 'SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_api_secret'
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
.
This application uses the lightweight Flask Framework. Begin by creating a configuration file for your application:
cp .env.example .env
Edit .env
with the four configuration parameters we gathered from above. Export
the configuration in this file as system environment variables like so on Unix
based systems:
source .env
Next, we need to install our depenedencies:
sudo pip install -r requirements.txt
Now we should be all set! Run the application using the python
command.
python app.py
Your application should now be running at http://localhost:5000. Open this page in a couple browsers or tabs, and start playing!
MIT