sonicjs

(β˜… 1,686)

SonicJS - The edge-native headless CMS for Cloudflare Workers. Sub-100ms response times, zero cold starts, TypeScript-first. Built on D1, R2, and Hono.

  • .claude_project
  • .gitignore
  • AGENTS.md
  • CLAUDE.md
  • CODING_STANDARDS.md
  • CONTRIBUTING.md
  • docker-compose.yml
  • docker-entrypoint.sh
  • Dockerfile
  • GOVERNANCE.md
  • LICENSE
  • package-lock.json
  • package.json
  • PLUGIN_FRAMEWORK_CONVERGENCE_PLAN.md
  • PLUGIN_FRAMEWORK_DEV_PLAN.md
  • PLUGIN_SYSTEM_OVERHAUL_PLAN.md
  • project-plan.md
  • PUBLISHING.md
  • README.md
  • tsconfig.json
  • vitest.config.ts

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/SonicJs-Org/sonicjs

Downloads the entire project code from GitHub to your computer.

cd sonicjs

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t sonicjs .

Builds a runnable image based on the Dockerfile.

docker run -d --name sonicjs -p 3000:3000 \

Runs the built image as an actual container.

docker exec sonicjs npm run reset

Type this command into your terminal and run it.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
docker exec sonicjs npm run reset

Type this command into your terminal and run it.

npm run dev

Starts the development/run server.

npm install

Downloads and installs the libraries listed in package.json.

npm run build:core

Builds optimized production files.

npm test

Type this command into your terminal and run it.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation