SDKs Overview
Easy AppServer provides SDKs for building applications on the platform.
Available SDKs
Dev Kit
Development toolkit for local app development with hot module replacement (HMR).
Key Features:
- CLI for starting/stopping development environment
- Automatic authentication and app registration
- Vite plugin for cross-origin CSS bundling
- Process management with health checks
- Docker shell integration
Package: @easy/dev-kit
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 | Dev Kit | Node.js SDK | Frontend SDK |
|---|---|---|---|
| Runtime | Node.js CLI | Node.js | Browser |
| Purpose | Local development | Backend apps | Microfrontends |
| Authentication | Kratos session | Certificate-based | Session-based |
| API Access | GraphQL | gRPC | HTTP/GraphQL |
| State | Process management | Server-side | Client-side |
| Frameworks | Vite | Any Node.js | Vue 3 (others possible) |
Getting Started
Dev Kit
pnpm add -D @easy/dev-kit
Node.js SDK
npm install @easy/appserver-sdk
Frontend SDK
npm install @easy/appserver-frontend-sdk
Development Workflow
Typical development workflow using the SDKs:
- Create app project - Set up your app directory structure
- Install SDKs - Add
@easy/dev-kit,@easy/appserver-sdk, and/or@easy/appserver-frontend-sdk - Configure dev-kit - Create
devkit.config.tsfor local development - Implement backend - Use Node.js SDK for lifecycle hooks (if applicable)
- Build microfrontend - Use Frontend SDK for Vue integration
- Test locally - Run
easy-dev startfor HMR development - Build and push assets - Build production assets
- Register with AppServer - Deploy to staging/production
- Install and test - Verify in production environment
See Dev Kit App Setup for a complete local development guide.