create-olgax-site

CLI reference for create-olgax-site, the command that scaffolds a complete Olgax DXP project with Payload CMS, Next.js and the Puck page builder.

npx create-olgax-site <project-name>

Also works with pnpm dlx create-olgax-site <project-name>.

Requirements

Converts <project-name> to a folder name (lowercase, hyphens) and refuses to continue if that folder exists and is not empty.
Copies the project template.
Renames the template's gitignore to .gitignore and sets the package name.
Creates .env from .env.example with a freshly generated random PAYLOAD_SECRET.
Runs pnpm install.
Runs pnpm seed to create an admin user, a published home page and a reusable cta-banner section.
Prints the next steps.

If step 5 or 6 fails, the CLI tells you which command to run yourself.

cd my-site
pnpm dev

What	Where
Site	`http://localhost:3000`
Page builder	`http://localhost:3000/home/edit`
Dashboard	`http://localhost:3000/dashboard`
Admin	`http://localhost:3000/admin`
Login	`[email protected]` and `ChangeMe123!`. Change the password.

Script	Purpose
`pnpm dev`	Start the dev server
`pnpm build` and `pnpm start`	Build and run for production
`pnpm lint`	Lint the project
`pnpm seed`	Create the admin user and demo content
`pnpm new:component Name`	Generate a custom block. See Custom components.
`pnpm migrate:create`, `pnpm migrate`, `pnpm migrate:status`	Database migrations. See Production.
`pnpm generate:types`	Regenerate Payload's TypeScript types
`pnpm generate:importmap`	Regenerate Payload's admin import map
`pnpm payload`	Run the Payload CLI