Skip to content

Showcase to demo PubNub features across a range of use cases

License

Notifications You must be signed in to change notification settings

markus-kohler/PubNub-Showcase

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

66 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WORK IN PROGRESS

PubNub Showcase application

Demo

A hosted version of this demo can be found at https://pubnubdevelopers.github.io/PubNub-Showcase/web/

Screenshot

Features of the Showcase and PubNub APIs used

Demo Description PubNub APIs used
Chat Uses the PubNub SDK to show how a chat application could be implemented, with features such as group messaging, typing indicators, message reactions, unread message counts and presence indicators. Publish & Subscribe, Presence, Persistence (for message history & unread message counts), Objects, Files, Message Actions (reactions & read indicators), Functions (for Text and Image moderation)
Virtual Events Shows how PubNub can make a high-occupancy virtual event interactive, with polls and live chat Publish & Subscribe (for polls and chat)
Geolocation Share your location or the location of any asset securely over PubNub Publish & Subscribe, Objects
Collaboration Real-time collaboration is demonstrated with a whiteboard app based the existing standalone collaboration demo Publish & Subscribe (for drawing), User State (for cursor position)
IoT Control IoT devices and infrastructure as well as see your device state using PubNub Publish & Subscribe
Real-Time Streaming Generate, process and deliver streaming data to any number of subscribers. Based on the standalone real-time data streaming demo Subscribe

Installing / Getting started

To run this project yourself you will need a PubNub account and (optionally) your own Google key to render the Google map used for Geolocation.

Requirements

PubNub Signup

Get Your PubNub Keys

  1. You’ll first need to sign up for a PubNub account. Once you sign up, you can get your unique PubNub keys from the PubNub Developer Portal.

  2. Sign in to your PubNub Dashboard.

  3. Click Apps, then Create New App.

  4. Give your app a name, and click Create.

  5. Click your new app to open its settings, then click its keyset.

  6. Enable the Presence feature on your keyset

  7. Enable the Persistence feature on your keyset

  8. Enable the Stream Controller feature on your keyset

  9. Enable the Files feature on your keyset

  10. Enable the Objects feature on your keyset. Make sure you check all the checkboxes related to events, i.e. User and Channel Metadata Events as well as Membership Events.

  11. Copy the Publish and Subscribe keys and paste them into your app as specified in the next step.

Building and Running

  1. Clone the repository

  2. Under the shared folder, open keys.js and add your keys here, replacing the existing placeholder data.

Contributing

Please fork the repository if you'd like to contribute. Pull requests are always welcome.

Further Information / Licenses

All avatar images licenced under MIT from DiceBear and Bootstrap Icons

About

Showcase to demo PubNub features across a range of use cases

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 68.6%
  • HTML 19.4%
  • CSS 12.0%