Git Product home page Git Product logo

ring-client-example's Introduction

ring-client-example

This is an example project that uses the ring-client-api npm package to access the Ring API from Node.js. It is intended to show a basic project structure with proper TypeScript configuration.

Setup

  • (Optional) Fork this repository if you want to push changes to your own copy
  • Clone the repository to your local environment
  • Run npm i (assuming you already have Node.js installed)

Authentication

  • Run npm run auth to start the process. It should prompt you for email/password/token
  • You will see a refresh token output like "refreshToken": "eyJhbGciOi...afa1". You need to extract the value from the second part of this output, between the double quotes.
  • Create a .env file in the root directory of this project and insert the following contents, replacing value with the one you got from the auth command above. Make sure you don't include the quotes:
RING_REFRESH_TOKEN=eyJhbGciOi...afa1

Run the Example

The example can be found in the example.ts file. Once you have followed the Authentication steps, you can start it by running npm start

Additional Examples

Additional examples of how to use the ring-client-api can be found in https://github.com/dgreif/ring/tree/main/packages/examples

ring-client-example's People

Contributors

dgreif 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.