Git Product home page Git Product logo

sync-quickstart-node's Introduction

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.

Temporary: Generating a Service Instance

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 curl command:

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:3000. Open this page in a couple browsers or tabs, and start syncing!

License

MIT

sync-quickstart-node's People

Contributors

dprothero avatar daveganly avatar lgerzz avatar kwhinnery avatar skuusk avatar

Watchers

Andres Jaan Tack avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.