How to Integrate SharePodLib into Your App — Step-by-Step

Build Real-Time Sharing with SharePodLib: Example Projects

Real-time sharing lets users collaborate, sync data, and exchange content instantly. SharePodLib is a lightweight library designed to simplify real-time sharing across web and mobile apps. Below are three practical example projects that demonstrate core patterns: peer-to-peer file sharing, collaborative text editing, and live presence with shared state. Each example includes architecture, key code snippets, deployment notes, and extensions you can add.

1) Peer-to-Peer File Sharing (Web)

Use case: Users exchange files directly without server-side storage.

Architecture

• Clients connect to a signaling server (WebSocket) to discover peers.
• SharePodLib manages peer connections and file-chunk transfers via WebRTC data channels.
• Optional server relaying for NAT traversal fallbacks.

Key steps

1. Initialize SharePodLib and connect to signaling.
2. Create or join a room.
3. Select file and send in chunks.
4. Receiver reassembles chunks and offers download.

Minimal example (conceptual)

javascript
Copy CodeCopied
import SharePodLib from ‘sharepodlib’;

const sp = new SharePodLib({ signalingUrl: ‘wss://signal.example.com’ });
await sp.connect();
const room = await sp.joinRoom(‘room-123’);

// Send file
document.querySelector(’#file’).addEventListener(‘change’, async (e) => {
const file = e.target.files[0];
  await sp.sendFile(room.id, file, {
    chunkSize: 64 * 1024, // 64KB chunks
    onProgress: (sent, total) => console.log(sent / total)
  });
});

// Receive file
sp.on(‘file-received’, ({ from, fileMeta, getStream }) => {
  const stream = getStream();
  // reassemble or create blob directly
  const url = URL.createObjectURL(stream);
  const a = document.createElement(‘a’);
  a.href = url;
  a.download = fileMeta.name;
  a.textContent = </span><span class="token template-string" style="color: rgb(163, 21, 21);">Download </span><span class="token template-string interpolation interpolation-punctuation" style="color: rgb(57, 58, 52);">${</span><span class="token template-string interpolation">fileMeta</span><span class="token template-string interpolation" style="color: rgb(57, 58, 52);">.</span><span class="token template-string interpolation">name</span><span class="token template-string interpolation interpolation-punctuation" style="color: rgb(57, 58, 52);">}</span><span class="token template-string template-punctuation" style="color: rgb(163, 21, 21);">;
  document.body.appendChild(a);
});

Deployment notes

• Use a small signaling service (Heroku, Vercel serverless) handling room matchmaking.
• Provide TURN servers (e.g., coturn) for reliable connectivity behind NATs/firewalls.

Extensions

• Add resumable transfers, encryption per file, and transfer speed throttling.

2) Collaborative Text Editor (Web + Mobile)

Use case: Multiple users edit the same document with low-latency updates.

Architecture

• SharePodLib provides a shared CRDT or OT-backed document model synced over pub/sub channels.
• Changes are broadcasted to room participants; library merges concurrently.
• Persist document state to a backend (optional) for recovery.

Key steps

1. Create shared document with SharePodLib.
2. Bind document to editor (e.g., CodeMirror, Slate).
3. Listen for local edits and apply remote operations.

Minimal example (conceptual)

javascript
Copy CodeCopied
import SharePodLib from ‘sharepodlib’;
import CodeMirror from ‘codemirror’;

const sp = new SharePodLib({ signalingUrl: ‘wss://signal.example.com’ });
await sp.connect();
const doc = await sp.openDocument(‘doc-456’, { type: ‘crdt’, persist: true });

const editor = CodeMirror(document.getElementById(‘editor’), { value: doc.getText() });

// Local edits -> SharePodLib
editor.on(‘change’, (cm) => {
  const delta = cm.getValue(); // compute minimal ops in production
  doc.applyLocalChange(delta);
});

// Remote changes -> editor
doc.on(‘remote-change’, (ops) => {
  editor.setValue(doc.getText());
});

Deployment notes

• Persist documents in a database (Postgres, Redis) with versioning.
• Implement access control (read/write tokens) and optimistic UI for latency masking.

Extensions

• Add user cursors, offline edit queueing, and change history with replay.

3) Live Presence + Shared State (Mobile)

Use case: Show who’s online, their cursors/locations, and share small state like selected items or reactions.

Architecture

• Presence updates are lightweight messages broadcast frequently (e.g., every 2–5s).
• SharePodLib maintains ephemeral presence maps and a small synchronized state store.
• Use rooms to scope presence.

Key steps

1. Join presence-enabled room.
2. Broadcast presence (status, metadata) periodically.
3. Subscribe to presence map and shared state changes.

Minimal example (conceptual)

javascript
Copy CodeCopied
import SharePodLib from ‘sharepodlib’;
const sp = new SharePodLib({ signalingUrl: ‘wss://signal.example.com’ });
await sp.connect();
const room = await sp.joinRoom(‘lobby’, { presence: true });

// Announce presence
sp.updatePresence(room.id, { name: ‘Alex’, status: ‘active’, x: 120, y: 240 });

// Listen for presence updates
sp.on(‘presence-update’, (presenceMap) => {
  // presenceMap = { clientId: { name, status, x, y, lastSeen } }
  renderPresence(presenceMap);
});

// Shared small state
await sp.setSharedState(room.id, { playlistIndex: 3 });
sp.on(‘shared-state-update’, (state) => updateUI(state));

Deployment notes

• Limit presence message size; use delta updates.
• Implement smoothing for transient disconnects; treat absent >10s as offline.

Extensions

• Spatial presence (map avatars), permissioned state channels, and ephemeral reactions.

Security & Performance Best Practices

• Encrypt sensitive payloads end-to-end; use per-room symmetric keys negotiated via public-key crypto.
• Rate-limit broadcasts and coalesce frequent state updates to reduce bandwidth.
• Validate and sanitize any incoming operations before applying to shared state.
• Use batching and chunking for large transfers; backpressure control for receivers.

When to Use SharePodLib

• Real-time peer experiences (collaboration tools, co-browsing, multiplayer mini-games).
• Low-latency, direct client sync without heavy server state.
• Scenarios needing offline support and mergeable data types (CRDTs).

Next Steps (Quick)

1. Prototype one example (start with presence + shared state).
2. Add persistence and access control.
3. Test on mobile networks and add TURN servers if needed.