Getting started

Run the Next.js starter and publish a page.

Before you start

Create a site in the account portal.

The starter targets Node.js 20.9+ and pnpm 10. You can adapt its configuration to another runtime or package manager.

Get site credentials

Open your site's Keys page. Copy the client ID and generate a client secret. The secret appears once.

Add http://localhost:4000/api/auth/stormy to the site's allowed redirect URLs for local admin sign-in.

Create the project

npx @stormycms/cli init --name my-stormy-site --target ./my-stormy-site
cd my-stormy-site

Enter credentials when prompted. The CLI writes .env files and installs dependencies.

Check configuration

Set the same STORMY_CMS_CLIENT_ID and STORMY_CMS_CLIENT_SECRET in both .env files. Keep these URLs:

If you skipped the prompts, fill in the generated .env files. Keep client secrets server-side and never commit .env files.

Media uploads need S3 storage. You can add it later using the media setup guide.

Start the apps

pnpm dev

Open the admin at localhost:4000 and sign in with GitHub or Google.

1. Under Layouts, create a layout if none exists. Add an Outlet and save it.
2. Under Pages, choose New Page. Set the name to About and the slug to about.
3. Add a Heading, edit its text, and choose Save.
4. Open localhost:3000/about to see the page.

To add your own components, follow Components and schema.