Installation#

SignalX can be installed in several ways depending on your project setup.

Create a New Project#

The fastest way to get started is with our CLI:

npm create @sigx@latest my-app

This will scaffold a new project with:

• Vite for development and building
• TypeScript configuration
• SignalX and the Vite plugin pre-configured

Add to Existing Project#

Using npm#

npm install sigx @sigx/vite

Using pnpm#

pnpm add sigx @sigx/vite

Using yarn#

yarn add sigx @sigx/vite

Configure Vite#

Add the SignalX plugin to your Vite configuration:

// vite.config.ts
import { defineConfig } from 'vite';
import { sigxPlugin } from '@sigx/vite';

export default defineConfig({
    plugins: [sigxPlugin()],
});

TypeScript Configuration#

For the best TypeScript experience, update your tsconfig.json:

{
    "compilerOptions": {
        "jsx": "preserve",
        "jsxImportSource": "sigx",
        "moduleResolution": "bundler"
    }
}

Package Versions#

SignalX follows semantic versioning. Current packages:

Next Steps#

• Quick Start - Build your first component
• Signals - Learn about reactive state