/create-vanjs

🍦Kickstart your first VanJS project with ease!

Primary LanguageJavaScriptOtherNOASSERTION

create-vanjs

Scaffolding your first VanJS project in seconds!

Compatibility Note: Vite requires Node.js version 18+, 20+, 22+. However, some templates require a higher Node.js version to work, please upgrade if your package manager warns about it.

# NPM:
npm create vanjs@latest
# PNPM:
pnpm create vanjs@latest
# Deno:
deno run -A npm:create-vanjs@latest
# Bun:
bun create vanjs@latest

Then follow the prompts!

You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold a basic Vite + SSR + VanJS project, run:

# npm
npm create vanjs@latest my-vanjs-app -- --template node-base
# pnpm
pnpm create vanjs my-vanjs-app --template node-base
# Deno
deno run -A npm:create-vanjs --template deno-base
# Bun
bun create vanjs my-vanjs-app --template node-base

Currently supported template presets include:

Template Try online
node-base StackBlitz
node-base-ts StackBlitz
node-jsx StackBlitz
node-jsx-ts StackBlitz
node-ssr
node-ssr-ts
node-ssr-jsx
node-ssr-jsx-ts
vike
vike-ts
vike-jsx
vike-jsx-ts
deno-base
deno-base-ts
deno-jsx
deno-jsx-ts

You can use . for the project name to scaffold in the current directory.

Community Templates

create-vanjs is a tool to quickly start a project from a basic template for VanJS. Check out Awesome Vite for community maintained templates that include other tools or target different frameworks. You can use a tool like degit to scaffold your project with one of the templates.

About

This project is crafted by developers, for developers! If you don't need the mental gymnastics of React to manage local, derived or global state, composability or scalability, you can really develop applications of any kind or size with VanJS.

Attribution

This project is originally a fork of create-vite. Credit goes to all of its contributors.