SDKs Overview
Easy AppServer provides SDKs for building applications on the platform.
Available SDKs
Node.js SDK
Backend SDK for building AppServer applications in Node.js and TypeScript.
Key Features:
- Lifecycle hooks (onCreate, onStartUp, onRegister, onInstall, onUninstall, onDestroy)
- Type-safe AppContext
- PostgreSQL database client
- Certificate and key management
- Structured logging
- Graceful shutdown handling
- ESM and CommonJS support
Package: @easy/appserver-sdk
Frontend SDK
Browser-side SDK for building microfrontend applications.
Key Features:
- Session context access (user ID, roles, permissions)
- App settings management
- Authenticated HTTP fetch
- Module Federation adapter
- Iframe adapter
- Vue 3 integration (plugin, composables)
- Asset loading utilities
Package: @easy/appserver-frontend-sdk
SDK Comparison
| Feature | Node.js SDK | Frontend SDK |
|---|---|---|
| Runtime | Node.js | Browser |
| Purpose | Backend apps | Microfrontends |
| Authentication | Certificate-based | Session-based |
| API Access | gRPC | HTTP/GraphQL |
| State | Server-side | Client-side |
| Frameworks | Any Node.js | Vue 3 (others possible) |
Getting Started
Node.js SDK
npm install @easy/appserver-sdk
Frontend SDK
npm install @easy/appserver-frontend-sdk
Development Workflow
TODO: Document typical development workflow:
- Create app project
- Install SDK
- Implement lifecycle hooks (backend)
- Build microfrontend (frontend)
- Test locally
- Build and push assets
- Register with AppServer
- Install and test