Asterisms JS SDK Backend#

The Asterisms JS SDK Backend provides a comprehensive server-side solution for building applications within the Asterisms ecosystem. It offers services for authentication, storage, registration, notifications, and more.

Quick Start#

import { createSvelteKitBackendSDK } from '@asterisms/sdk-backend';
import { createFetchAdapter } from '@asterisms/sdk-backend';

const provider = createSvelteKitBackendSDK({
  env: process.env,
  building: false,
  httpFactory: createFetchAdapter(fetch),
  registrationData: {
    bundleId: 'com.example.app',
    capabilities: ['FRONTEND_WEBSITE'],
    description: 'My Asterisms Application',
    name: 'My App',
    subdomain: 'myapp',
    title: 'My App'
  }
});

// Boot the SDK
await provider.bootSDK();

// Use the SDK
const sdk = provider.sdk;
const auth = sdk.authorization();
const storage = sdk.storage();

Documentation Structure#

• Getting Started - Quick setup and basic usage
• Core Concepts - Understanding the SDK architecture
• API Reference - Complete API documentation
• Authentication & Authorization - User authentication and permissions
• Storage Services - Data persistence and storage
• Notification Services - Sending notifications
• Registration Services - App registration and discovery
• Middleware - Express middleware utilities
• Controllers - Pre-built API controllers
• Examples - Complete working examples
• Migration Guide - Upgrading between versions
• Troubleshooting - Common issues and solutions

Key Features#

• 🔐 Authentication: Built-in user authentication and authorization
• 💾 Storage: Secure data storage and retrieval
• 🔔 Notifications: User and workspace notifications
• 📋 Registration: App registration and service discovery
• 🛡️ Middleware: Express middleware for common patterns
• 🎯 Controllers: Pre-built API controllers
• 🔍 Discovery: Service discovery and ecosystem communication
• 📊 Logging: Structured logging and monitoring
• ⚡ Performance: Optimized for production use

Architecture#

The SDK Backend follows a service-oriented architecture where each service provides specific functionality:

Getting Help#

• Documentation: Browse the guides and API reference
• Examples: Check the examples directory for working code
• Issues: Report issues on the project repository
• Community: Join the Asterisms developer community

Next Steps#

1. Get Started - Set up your first backend service
2. Core Concepts - Learn the fundamental concepts
3. Examples - Explore working examples
4. API Reference - Dive into the complete API