Skip to main content

​
Installation

Get started with Resolid by installing the required packages for your use case.

​
System requirements

Resolid requires the following to be installed:
  • Node.js: Version 22.13.0 or 24+
  • Package manager: pnpm (recommended), npm, yarn, or bun
Resolid is built with modern Node.js features. Make sure you’re running a compatible version.

​
Core package

The @resolid/core package provides the application container, extension system, and core APIs: 
npm install @resolid/core
The core package includes:
  • createApp() - Application factory function
  • App class - Application container with lifecycle management
  • Extension system
  • Re-exports from @resolid/di and @resolid/event

​
Available packages

Resolid is split into focused packages. Install only what you need:

​
Dependency injection

Type-safe dependency injection container with singleton/transient scopes: 
npm install @resolid/di
Features:
  • Fully typed container
  • Singleton and transient scopes
  • Lazy resolution
  • Optional dependencies
  • Circular dependency detection
  • Disposable resources
The @resolid/di package is automatically included when you install @resolid/core.

​
Event emitter

Lightweight, typed event system: 
npm install @resolid/event
Features:
  • Type-safe events
  • Synchronous and asynchronous emission
  • Once listeners
  • Zero dependencies
The @resolid/event package is automatically included when you install @resolid/core.

​
Cache

Type-safe async cache with pluggable storage backends: 
npm install @resolid/cache
Features:
  • Get/set/delete/clear operations
  • Batch operations
  • Optional TTL
  • Custom store backends
  • In-memory and file-based stores included

​
Development tools

Vite integration, React Router support, and HTTP server: 
npm install @resolid/dev
Features:
  • defineDevConfig() for Vite and React Router configuration
  • HTTP server with Hono
  • Request utilities (client IP, request ID, origin)
  • Platform adapters (Node.js, Vercel, Netlify)
  • File-based routing with flex routes
The @resolid/dev package has peer dependencies on React Router and Vite. Install these separately.

​
Logging

Structured logging with LogTape integration: 
npm install @resolid/app-log
Features:
  • Integration with LogTape
  • Category-based logging
  • Multiple log levels (debug, info, warn, error, fatal)
  • Configurable sinks and filters
  • Structured logging support

​
Database

Database integration with Drizzle ORM: 
npm install @resolid/app-db
MySQL provider: 
npm install @resolid/app-db-mysql
Features:
  • Drizzle ORM integration
  • Database service providers
  • Repository pattern support
  • MySQL support (more databases coming soon)

​
File-based cache

File system cache backend: 
npm install @resolid/cache-file

​
File-based logging

File system logging target: 
npm install @resolid/app-log-file

​
Installation by use case

Choose the right packages for your project:
For a basic Resolid application with DI and events:
pnpm add @resolid/core
This includes @resolid/di and @resolid/event.

​
Verify installation

After installation, verify that Resolid is working: 
import { createApp } from "@resolid/core";

const app = await createApp({
  name: "test-app"
});

console.log(app.name); // "test-app"

await app.run();
await app.dispose();
If this runs without errors, you’re ready to go!

​
Next steps

Quickstart

Build your first Resolid application

Core concepts

Learn about the application architecture

Build docs developers (and LLMs) love

Get started for freeTalk to us