Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 1.46 KB

README.md

File metadata and controls

31 lines (20 loc) · 1.46 KB
Raw

ably-js React Native example

This provides a simple example of how to use ably-js from within a React Native app.

It was written for manually testing the Webpack version 5 migration in ably/ably-js#1184, but I think serves as a generally useful example.

Usage

How to run it

  1. Copy .env.example to .env, and replace insert_key_here with your Ably API key.
  2. Run npm install.
  3. Run npm start, and choose the one of the options to run on either iOS or Android. This will launch an iOS simulator or Android emulator.

Expected results after running

You should see the following log messages in your terminal (the last two may appear in the opposite order):

  • Hello World, from React Native!
  • Attached to channel
  • Published to Ably
  • Got message from Ably

Testing a non-published version of ably-js

These steps use npm pack, which emits a .tgz file similar to that uploaded by npm publish.

  1. Check out the ably-js repository at the commit you wish to test.
  2. At the root of the ably-js repository, run npm run build && npm pack --pack-destination <path>, where <path> is the directory you wish to output the .tgz file to.
  3. In the current repository, change the package.json’s dependencies.ably entry to "file:<tgz-file-path>", where <tgz-file-path> is the path to the .tgz file output by the previous step.
  4. Run npm install.