create-shirkhan-lib

Scaffolding shirkhan lib

Compatibility Note: shirkhan-lib requires Node.js version >=12.2.0. However, some templates require a higher Node.js version to work, please upgrade if your package manager warns about it.

With NPM:

$ npm init shirkhan-lib@latest

With Yarn:

$ yarn create shirkhan-lib

With PNPM:

$ pnpm create shirkhan-lib

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 shirkhan-lib + Vue project, run:

# npm 6.x
npm init shirkhan-lib@latest my-vue-app --template vue

# npm 7+, extra double-dash is needed:
npm init shirkhan-lib@latest my-vue-app -- --template vue

# yarn
yarn create shirkhan-lib my-vue-app --template vue

# pnpm
pnpm create shirkhan-lib my-vue-app -- --template vue

Currently supported template presets include:

• vanilla
• vanilla-ts

Community Templates

create-shirkhan-lib is a tool to quickly start a project from a basic template for popular frameworks. You can use a tool like degit to scaffold your project with one of the templates.

npx degit user/project my-project
cd my-project

npm install
npm run dev

If the project uses main as the default branch, suffix the project repo with #main

npx degit user/project#main my-project