快速上手

这里是通过 create-saqu 命令快速开始一个项目。

环境准备

首先得有 nodejs，并确保 nodejs 版本是 14 或以上。（推荐用 n 来管理 node 版本，windows 下推荐用 nvm-windows）

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

如果 npm 没有的情况

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

使用 n 安装 nodejs 指定版本

$ n 18.12.1
$ n lts
$ n

  node/4.9.1
ο node/8.11.3
  node/10.15.0

初始化一个项目

# 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 参数生成如下其中之一的示例：

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

帮助

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

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

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.