# create-shirkhan-lib

**Repository Path**: shirkhan/create-shirkhan-lib

## Basic Information

- **Project Name**: create-shirkhan-lib
- **Description**: 从create-vite 改造的，shirkhan 常用的库生成脚手架
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-20
- **Last Updated**: 2022-03-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: JavaScript

## README

# create-shirkhan-lib

## Scaffolding shirkhan lib

> **Compatibility Note:**
> shirkhan-lib requires [Node.js](https://nodejs.org/en/) 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:

```bash
$ npm init shirkhan-lib@latest
```

With Yarn:

```bash
$ yarn create shirkhan-lib
```

With PNPM:

```bash
$ 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:

```bash
# 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](https://github.com/Rich-Harris/degit) to scaffold your project with one of the templates.

```bash
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`

```bash
npx degit user/project#main my-project
```