Skip to content

快速开始 ​

本页介绍使用 NeosJS 各包之前需要了解的内容:环境要求、包管理器、安装方式,以及如何查阅文档。

环境要求 ​

  • Node.js 18+(推荐使用 LTS 版本)
  • 推荐使用 pnpm 作为包管理器
  • 建议使用支持 TypeScript 的编辑器(如 VS Code),各包均附带类型定义

包管理器 ​

NeosJS 的所有包都发布在 npm 上,pnpm / npm / yarn 均可安装,推荐使用 pnpm。

关于镜像源

NeosJS 仓库及文档工程的 .npmrc 已配置 npmmirror 镜像源:

ini
registry=https://registry.npmmirror.com

国内网络环境可以直接使用;如需查询包的实时信息或发布新版本,请切换回 npm 官方源 https://registry.npmjs.org/。

安装包 ​

NeosJS 按能力拆分为多个独立包,需要什么就安装什么。例如安装工具函数库:

sh
pnpm add @neosjs/utils
sh
npm i @neosjs/utils
sh
yarn add @neosjs/utils

安装网络请求库:

sh
pnpm add @neosjs/request
sh
npm i @neosjs/request
sh
yarn add @neosjs/request

其余包的安装命令见各包文档的「安装」章节,包名统一以 @neosjs/ 开头。

可选依赖

少数包带有可选的 peerDependencies(例如 @neosjs/utils 的 dayjs、@vueuse/core、throttle-debounce)。只有用到相关功能时才需要安装对应依赖,详见各包文档中的说明。

如何查阅文档 ​

  • 使用左侧边栏按分类浏览:指南、工具库、网络请求、数据存储、媒体与图像、组件、Electron 桌面端、开发工具。
  • 每个包的文档都遵循相同结构:简介 → 安装 → 快速上手 → API,可以按顺序快速上手。
  • 顶部的搜索框可以全文检索文档内容。

从脚手架开始 ​

如果是从零开始一个新项目,可以直接使用官方脚手架创建,它会生成配置完整、开箱即用的 Vue 3 项目:

sh
pnpm create @neosjs/app@latest # 推荐使用 pnpm
sh
npm create @neosjs/app@latest
sh
yarn create @neosjs/app@latest

详细用法见 create-app。