Install and configure sonicjs

Follow the source instructions for sonicjs. Read the prerequisites and configuration steps before running an example.

Get Started

1npx create-sonicjs@latest my-app

$0 to start · No signup required · Runs anywhere SQLite runs

⚠️ Note: This repository is for developing the SonicJS core package. To build an application with SonicJS, use the command above to create a new project.

Quick Start

For Application Developers (Using SonicJS)

1# Create a new SonicJS application
2npx create-sonicjs@latest my-app
3 
4cd my-app
5npm run dev
6 
7# Visit http://localhost:8787

Your app includes:

✅ SonicJS CMS pre-configured
✅ Database migrations ready
✅ Example content collections
✅ Admin interface at /admin
✅ Ready to deploy to Cloudflare

For Package Developers (Contributing to SonicJS)

1# Clone this repository
2git clone https://github.com/Up-to-code/sonicjs.git
3cd sonicjs
4 
5# Install dependencies
6npm install
7 
8# Build the core package
9npm run build:core
10 
11# Create a test app to validate changes
12npx create-sonicjs@latest my-sonicjs-app
13 
14# Run tests
15npm test

Setting Up a Fresh Database

1# Create a fresh D1 database for your branch (run from project root)
2npm run db:reset

This creates a new D1 database named sonicjs-worktree-<branch-name>, applies all migrations, and updates wrangler.toml.

Working with Database Migrations

Migrations live in packages/core/migrations/. Test apps reference them via npm workspace symlink.

From your test app directory (e.g., my-sonicjs-app/):

1# Check migration status
2wrangler d1 migrations list DB --local
3 
4# Apply pending migrations
5wrangler d1 migrations apply DB --local
6 
7# Apply to production
8wrangler d1 migrations apply DB --remote

Creating New Migrations:

SonicJS bundles migrations at build time (Workers can't access the filesystem at runtime).

Create packages/core/migrations/NNN_description.sql (use CREATE TABLE IF NOT EXISTS and INSERT OR IGNORE for idempotency)
Regenerate bundle: cd packages/core && npm run generate:migrations
Rebuild: npm run build:core
Apply locally: cd my-sonicjs-app && wrangler d1 migrations apply DB --local

Common Commands

1npm run dev          # Start dev server
2npm run deploy       # Deploy to Cloudflare
3npm run db:migrate   # Apply migrations
4npm run db:studio    # Open database studio
5npm test             # Run tests

Check the installation

After setup, continue with the first example. If a command fails, compare the runtime version, working directory, and required configuration with the original README before changing dependencies.

Source and help

The catalog identifies the license as MIT. Read the repository license before redistributing source or assets.

This catalog entry is a fork. The README may describe upstream packages, domains, or release procedures; those destinations do not establish a separate release of this fork.