Getting Started
Scaffold a project
npx create-nextop-app my-app# or with an explicit name prompt:npx create-nextop-app
The CLI:
- Copies the default template into
./my-app. - Rewrites
package.jsonnameto the project directory name. - Runs
npm install.
Flags
| Flag | Description |
|---|---|
[project-directory] | Target directory (prompted if omitted). |
--link | Runs npm link nextop-app before install to use a locally linked build of the library. Best-effort — silently continues with the registry version if no global link exists. Intended for NextOP development. |
Run it
cd my-appnpm run dev # nextop dev → compiles Electron + launches the in-process Next dev servernpm run build # nextop build → next build + Electron compile + electron-builder package
Stack of a freshly scaffolded app
Next.js 16, React 19, Tailwind CSS v4, Electron 39, TypeScript 5, electron-builder 25.
The scaffolded app contains an app/ (Next.js App Router), an electron/ entry layer
(main.ts, preload.ts, startNext.ts, types.d.ts), next.config.mjs at the project root,
Tailwind v4, and TypeScript.