Skip to content

README.md

Latest commit

 

History

History
68 lines (46 loc) · 1.89 KB

README.md

File metadata and controls

68 lines (46 loc) · 1.89 KB

Ziex App with Node Package Managers

This is a starter template for building web applications with Ziex, a full-stack web framework for Zig.

This project can be used without having to installe Zig or Ziex globally, it works with any Node package manager (npm, yarn, pnpm, bun, etc).

Documentation →

Install Dependencies

You can use bun/npm/yarn/pnpm or any other Node package manager, the following guides uses Bun as an example.

bun install

Usage

Development

bun dev

App will be available at http://localhost:3000. with hot reload enabled.

Serve Production Build

bun serve

Exporting as Static Site

bun export

This will create a dist/ directory with the static export of your app. You can deploy the contents of dist/ to any static hosting provider (Netlify, Vercel, GitHub Pages, etc) or serve it with any static file server.

Deployment

bun bundle

This will create a bundle/ directory with the binary and static assets needed to run your app. You can deploy the contents of bundle/ to any VPS.

ZX CLI Commands

bun zx [command] [options]

All ZX CLI commands are available under bun zx [command]. For example, to run auto formatter:

bun zx fmt .

Contributing

Contributions are welcome! Feel free to open issues or pull requests. For feature requests, bug reports, or questions, see the Ziex Repo.

Links