Yuuka's Docs

Appearance

创建模板项目 ​

WARNING

如果想自行配置，请移步自由配置

本页内容会介绍Yuuka如何创建模板项目，相比于自由配置，模板项目有以下的优/缺点:

  • 开发者推荐的配置与开发工具
  • 可以直接在workspace中开发
  • 可以直接使用TypeScript运行插件，既可以享受类型检查和代码提示的便利，又可以即时运行
  • 不如自由配置自由度高，但对于普通开发者和用户已经足够大部分的使用

安装Node.js ​

Yuuka是用运行在Node.js上的程序，因此第一步是先安装Node.js

下载安装包 ​

前往Node.js的网站，下载对应系统的安装包，推荐更加稳定的LTS版本，因为Node.js官方会阶段性长时间维护这个版本

Node.js

下载安装包后按照引导，逐步安装即可

安装包管理器 ​

Node.js安装后会自带npm包管理器，但我们推荐Yarn包管理器，它的功能更加强大，只需输入一下命令:

bash
# 安装Yarn

npm i yarn -g

# 查看Yarn版本

yarn -v

配置镜像源 可选 ​

国内的用户安装依赖时会比较慢，我们推荐你配置镜像源，只需输入以下命令:

bash
yarn config set registry https://registry.npmmirror.com

创建项目 ​

打开命令行，并进入你想要创建Yuuka项目的目录

输入以下命令:

bash
yarn create koishi

跟随提示即可完成全套初始化流程

输入yarn start之后，Yuuka便启动了，通过Ctrl+C便可关闭，若想再次启动只需再次输入yarn start即可

下一步 ​