quick start

Quick Start Guide

🚀 Get Started in 3 Steps

1. Clone & Start

git clone https://github.com/ferdiunal/soketi.rs.git
cd soketi-rs
docker-compose up -d

2. Open Demo

open http://localhost:3000

3. Start Coding

// Connect to Soketi
const pusher = new Pusher('app-key', {
  wsHost: 'localhost',
  wsPort: 6001,
  forceTLS: false
});

// Subscribe to channel
const channel = pusher.subscribe('my-channel');

// Listen for events
channel.bind('my-event', (data) => {
  console.log('Received:', data);
});

📚 Next Steps

• Getting Started
• Installation
• Configuration
• API Reference
• Deployment Guide

🎯 Common Use Cases

Real-time Chat

channel.bind('message', (data) => {
  displayMessage(data.user, data.message);
});

Live Notifications

channel.bind('notification', (data) => {
  showNotification(data.title, data.body);
});

Presence Tracking

const presence = pusher.subscribe('presence-room');
presence.bind('pusher:member_added', (member) => {
  console.log('User joined:', member.info.name);
});

🔧 Configuration

Edit config.json:

{
  "host": "0.0.0.0",
  "port": 6001,
  "app_manager": {
    "driver": "Array",
    "array": {
      "apps": [{
        "id": "app-id",
        "key": "app-key",
        "secret": "app-secret"
      }]
    }
  }
}

📞 Need Help?

• GitHub Issues
• Troubleshooting