stdf/packages/create-stdf/README.md

简体中文

create-stdf

A CLI for creating new STDF projects. Just run...

pnpm create stdf

npm create stdf@latest
# or
npm init stdf@latest
# or
npx create-stdf@latest

bun create stdf

yarn create stdf

...and 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 create a new project named my-app using the SvelteKit + Tailwind + STDF template, run:

pnpm create stdf my-app

npm create stdf@latest my-app

bun create stdf my-app

yarn create stdf my-app

If you want to use the Vite + UnoCSS + Svelte + STDF template, run:

pnpm create stdf my-app --template vu
# or
pnpm create stdf my-app -t vu

npm create stdf@latest my-app --template vu
# or
npm create stdf@latest my-app -t vu

bun create stdf my-app -template vu
# or
bun create stdf my-app -t vu

yarn create stdf my-app --template vu
# or
yarn create stdf my-app -t vu

Template presets include:

abbreviation	template	description
skt	SvelteKit + Tailwind + STDF	default
vt	Vite + Tailwind + Svelte + STDF	-
vu	Vite + UnoCSS + Svelte + STDF	-
sku	SvelteKit + UnoCSS + STDF	-
vtt	Vite + Tailwind + TypeScript + Svelte + STDF	Has not adapted yet
vut	Vite + UnoCSS + TypeScript + Svelte + STDF	Has not adapted yet
sktt	SvelteKit + Tailwind + TypeScript + STDF	Has not adapted yet
skut	SvelteKit + UnoCSS + TypeScript + STDF	Has not adapted yet

Options

Option	Type	Default	Description
-	string	-	The name of the project, you can direct input.
-t / --template	string	vt	The template to use. Available templates are: vt, vu, skt, sku, vtt, vut, sktt, skut.
-l / --language	string	en_US	The language of the prompts.

Supported Languages

Code	Language
en_US	English (US)
zh_CN	Chinese (Simplified)
zh_TW	Chinese (Traditional)
ja_JP	Japanese
ko_KR	Korean
es_ES	Spanish
ru_RU	Russian
fr_FR	French
de_DE	German
it_IT	Italian

For example:

pnpm create stdf my-app -l zh_CN

npm create stdf@latest my-app -l zh_CN

bun create stdf my-app -l zh_CN

yarn create stdf my-app -l zh_CN

License

This project is licensed under the MIT License. Feel free to enjoy and contribute to this open-source project.