Skip to content

Getting Started

ZhinNX is a frontend framework for developers who need to ship small to medium web apps quickly without carrying unnecessary concepts. It focuses on simple routing, simple state, useful UI helpers, templates, debug tools, and deploy-ready CLI commands.

Requirements

ZhinNX needs Node.js for local development. You can use npm, pnpm, Yarn, Bun, or Deno to create and install projects.

Create your first project

npx zhinnx@beta create my-app --template landing --vercel

Run the app

bash
cd my-app
npm install
npm run dev

Open the local URL printed by the dev server. The generated app already includes a working ZhinNX page and basic styling.

Write a page

js
import { page } from 'zhinnx'

page('/', () => `
  <main>
    <h1>Hello ZhinNX</h1>
    <p>This page is rendered by ZhinNX.</p>
  </main>
`)

Build for production

bash
zz build

The build command outputs a static dist folder. You can deploy it to Vercel, Netlify, or any static hosting provider.

Next steps

Read Core Concepts, then continue to State & Storage, CLI, and Deployment.

Released under the MIT License.