/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.

Usage

# 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!

Note: if you execute the create command with other package manager than npm, your project's package.json scripts will be updated to use that package manager. (EG: bun create vanjs will rename scripts to bun run build).

Current Directory

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

# npm
npm create vanjs@latest .

Specify Template

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 + VanJS project, run:

# npm
npm create vanjs@latest my-vanjs-app -- --template node-base

Templates

Currently supported template presets include:

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

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! Now 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.