Start here

Install & create

One command scaffolds a working application: a domain, a context to run it locally, and the build tooling wired up. You will write logic within minutes, and choose where it deploys later.

#Requirements

Node.js 20 or newer, and a package manager. Stone.js is ESM-only and ships modern TypeScript. Nothing else is required to start; adapters are added per context, not upfront.

terminalbash

node -v   # v20.x or newer

Managing several Node versions? nvm makes switching painless.

#Create a project

One command scaffolds a working app with your package manager of choice. It is interactive by default; the tabs below use each manager's create command.

npm create @stone-js@latest my-app
cd my-app && npm install
pnpm create @stone-js@latest my-app
cd my-app && pnpm install
yarn create @stone-js my-app
cd my-app && yarn

The scaffolder asks what you are building. Every answer is an adapter it adds to a working app; none of them locks the domain to a platform. Two shortcuts:

Shortcut	Type	Description
-- -y	`flag`	Skip the prompts and accept sensible defaults (yarn/pnpm: -y).
create @stone-js .	`in place`	Scaffold into the current directory instead of a new one.

#Run it

terminalbash

npm run dev      # local dev server, hot reload
npm run build    # production build for your target
npm run preview  # serve the production build

build emits a single, self-contained artifact in dist/, no node_modules to ship, ready to drop onto any JavaScript runtime. Where it goes is the deploy step, which the next page is about.

#Project shape

my-app/text

app/            your domain: handlers, services, pages
  Application.ts  the app manifest (adapters live here)
assets/         styles and static files
stone.config.mjs  build and rendering config