meeko init

meeko init creates the component engine starter: a server-rendered page hydrated in the browser, without file-based routing, meeko.config.ts, app/ or server/. It is the starting point for using .meeko components inside your own server or learning how SSR and hydration work without the framework. For a complete application, use meeko init-framework.

It does not install dependencies or overwrite files: it writes the project and tells you the next step.

Usage#

npx @meekojs/meeko init mi-app

Proyecto creado en C:\proyectos\mi-app
Siguiente paso: cd C:\proyectos\mi-app && npm install && npm run dev

Type#

meeko init <directorio>

Parameters#

Result#

mi-app/
├── .gitignore          node_modules/, dist/, .meeko/
├── README.md
├── index.html
├── package.json
├── server.mjs          Node server: Vite in development, dist/ with --production
├── tsconfig.json       with allowArbitraryExtensions and rootDirs over .meeko/types
├── vite.config.ts      plugins: [meeko()]
└── src/
    ├── App.meeko       a counter with props and a signal
    ├── entry-client.ts hydrates with props and server state
    └── entry-server.ts renders with renderWithState

package.json pins @meekojs/meeko to the exact version that created the project (compiled code and runtime must match), adds @types/node, typescript and vite and declares these scripts:

The message says pnpm instead of npm if the folder already had pnpm-lock.yaml. If the directory is the current one, it omits cd.

Examples#

A new project#

npx @meekojs/meeko init contador
cd contador
npm install
npm run dev
# http://localhost:4173

In the current folder, with the package already installed#

mkdir contador && cd contador
pnpm add @meekojs/meeko
pnpm exec meeko init .
pnpm install
pnpm run dev

package.json, pnpm-lock.yaml and node_modules are preserved: init adds its scripts and dependencies to the existing package.json.

Check and build#

npm run check   # generates .meeko/types/src/App.d.meeko.ts and runs tsc
npm run build   # dist/client and dist/server
npm start       # serves dist/ with SSR at 127.0.0.1:4173

MEEKO_PORT (or PORT) changes the port of server.mjs; the address is always 127.0.0.1, and you change it by editing server.mjs, which is now project code.

Common mistakes#

A folder containing files#

meeko init mi-app   # mi-app ya has src/ e index.html

El destino no está vacío: C:\proyectos\mi-app (.gitignore, index.html, README.md, server.mjs, src, tsconfig.json, vite.config.ts)

The list shows entries that prevent project creation; nothing is written. A folder containing only .git is accepted since 1.7; with lockfiles or node_modules but no package.json, the message ends in (sin package.json). Messages have been in Spanish since 1.7.

meeko init mi-app-nueva

A package.json with other scripts or dependencies#

# package.json with "scripts": { "dev": "vite" } or with "dependencies": { "react": "…" }
meeko init .

El destino ya define el script dev: C:\proyectos\mi-app or El destino tiene otras dependencias: C:\proyectos\mi-app. The starter only merges with a newly created package.json.

npm init -y && meeko init .

Omit the directory#

meeko init

Falta el directorio de init, with usage and exit code 1.

meeko init .

Notes#

• Engine, not framework. The starter has no routes, layouts, API, sessions or meeko dev: server.mjs is an example server that renders / with renderWithState and serves assets. The project decides everything else.
• Types. meeko types src/App.meeko writes component declarations in .meeko/types/, and tsconfig.json overlays them on src/ with rootDirs; this is why check runs it before tsc.
• Shutdown. server.mjs closes HTTP and Vite on SIGINT and SIGTERM, preserves both causes if both fail and exits with an error code.
• Windows and POSIX. Scripts use node and vite without shell syntax, so they work the same in PowerShell, cmd and POSIX.
• Node 24. package.json declares "engines": { "node": ">=24" }.

Related#

• meeko init-frameworkCreates a full-stack Meeko application with meeko.config.ts, app/, a layout, a prerendered page, .env.example and CLI scripts.
• meeko typesGenerates a component's .d.meeko.ts declaration and those of its imported components in .meeko/types/, so TypeScript can check their props.
• meeko compileChecks a .meeko component and compiles it to a TypeScript module with its server render, hydration and types.
• meeko (Vite)Meeko's Vite plugin, compiling .meeko imports for the client and SSR, adding HMR and CSS in development, applying auto-imports and generating framework virtual modules.
• ToolsMeeko API
• Create an applicationMeeko as a full-stack framework