# create-saqu

> Creates a saqu application using the command line.

Latest version **0.1.40** (published 2024-10-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install create-saqu
pnpm add create-saqu
yarn add create-saqu
bun add create-saqu
```

Provides the command `create-saqu`.

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.40 |
| Published | 2024-10-24 |
| First published | 2023-07-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 9.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | SunLxy |
| Maintainers | sunluxy |
| Keywords | kkt, ncc, nodejs, cra, build-tools, create-react-app, zero-configuration, framework |

## Links

- npm: https://www.npmjs.com/package/create-saqu
- Repository: https://github.com/SunLxy/saqu
- Homepage: https://github.com/SunLxy/saqu#readme
- Issues: https://github.com/SunLxy/saqu/issues
- npm.io page: https://npm.io/package/create-saqu

## Dependencies (1)

- [create-kkt](https://npm.io/package/create-kkt.md) 3.0.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.1.40 (latest) — 2024-10-24
- 0.1.39 — 2024-04-29
- 0.1.38 — 2024-04-02
- 0.1.37 — 2023-11-22
- 0.1.36 — 2023-09-22
- 0.1.35 — 2023-09-04
- 0.1.34 — 2023-09-02
- 0.1.33 — 2023-08-31
- 0.1.32 — 2023-08-31
- 0.1.31 — 2023-08-29
- 0.1.30 — 2023-08-28
- 0.1.29 — 2023-08-28
- 0.1.28 — 2023-08-28
- 0.1.27 — 2023-08-18
- 0.1.26 — 2023-08-11
- … 19 more at https://npm.io/package/create-saqu/versions

## README

## 快速上手

这里是通过 [`create-saqu`](https://github.com/SunLxy/saqu) 命令快速开始一个项目。

## 环境准备

首先得有 [nodejs](https://nodejs.org/en)，并确保 [nodejs](https://nodejs.org/en) 版本是 14 或以上。（推荐用 [n](https://github.com/tj/n) 来管理 node 版本，windows 下推荐用 [nvm-windows](https://github.com/coreybutler/nvm-windows)）

```bash
# 🚧 注意：不适用于 Microsoft Windows 上的本机 shell
# 适用于 Linux 的 Windows 子系统和各种其他类 unix 系统
npm install -g n 
```

如果 npm 没有的情况

```bash
curl -L https://raw.githubusercontent.com/tj/n/master/bin/n -o n
bash n lts
# 现在可以使用 node 和 npm
npm install -g n
```

使用 [`n`](https://github.com/tj/n) 安装 [nodejs](https://nodejs.org/) 指定版本

```bash
$ n 18.12.1
$ n lts
$ n

  node/4.9.1
ο node/8.11.3
  node/10.15.0
```

## 初始化一个项目

```shell
# npm 6.x
$ npm init saqu my-app --example base
# npm 7+, extra double-dash is needed:
$ npm init saqu my-app -- --example base

$ yarn create saqu [appName]
# or npm
$ npm create saqu my-app
# or npx
$ npx create-saqu my-app
```

使用 `-e auth` 或 `--example auth` 参数生成如下其中之一的示例：

```bash
└─ examples
   ├── base        # 基础示例
   └── routes       # 路由实例
```

## 帮助

你可以通过`--help | h`来查看帮助. 

实例下载： https://autumnstale.github.io/create-saqu-template/

```bash
Usage: create-saqu <app-name> [options] [--help|h]

Options:

  --version, -v   Show version number
  --help, -h      Displays help information.
  --output, -o    Output directory.
  --example, -e   Example from: https://github.com/SunLxy/saqu, default: "base"
  --path, -p      Specify the download target git address.
                    default: "https://autumnstale.github.io/create-saqu-template/"

Example:

  yarn create saqu appName
  npx create-saqu my-app
  npm create saqu my-app
  npm create saqu my-app -f
  npm create saqu my-app -p https://autumnstale.github.io/create-saqu-template/

Copyright 2023
```

### License

Licensed under the MIT License.

---
_Source: https://npm.io/package/create-saqu · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._