SocketBee Documentation

Appearance

Getting Started ​

This guide will walk you through the process of getting started with SocketBeeClient, including creating an app in the SocketBee dashboard and authenticating your application using the app ID and key.

Step 1: Create an App ​

  1. Log In: Visit the SocketBee website and log in to your account.

  2. Select Team (Optional): If you are a part of multiple teams, select the team where you want to create the app. By default, users have a personal team.

  3. Create App:

    • Navigate to the dashboard.
    • Click on the "Create App" button.
    • Enter a name for your app and click "Create".

  4. Retrieve App ID and Key:

    • Once the app is created, you will be redirected to the app's settings page.
    • Note down the "App ID" and "App Key" provided on this page. These will be used to authenticate your application.

Step 2: Include SocketBeeClient in Your Project ​

To include SocketBeeClient in your project, you can use the following CDN link:

html
<script src="https://www.unpkg.com/@socketbee/client@0.2.1/dist/socketbee.min.js"></script>

Step 3: Authenticate Your Application ​

To authenticate your application using the app ID and key, you need to create an instance of SocketBeeClient with these credentials:

javascript
const app_id = 'your_app_id';
const app_key = 'your_app_key';

const socketClient = new SocketBeeClient(app_id, app_key);

You are now ready to use SocketBeeClient in your application to subscribe to channels, listen for events, and broadcast messages in real-time.

Let's build something amazing with SocketBeeClient!