快速上手

TIP

周一至周五晚8:30，直播撰写文档，欢迎围观：B站: 濮水代码

前置条件

名称	版本
pnpm	>=10.19.0
Nodejs	>=24.8.0
Redis	>=7.2.6
Sqlite3	内置
MySQL	>=8
Postgresql	>=17

• Redis: VonaJS 基于 Redis 提供了以下能力:
  • 队列、定时任务、启动项、广播、缓存、二级缓存、分布式锁
• Sqlite3: 需要预先准备 node-gyp 环境，确保在安装依赖时可以正常编译出better_sqlite3.node

准备工作

1. 安装命令行工具

$ pnpm add -g vona-cli@latest

2. 安装 Vscode 插件：Vona - Official

该插件提供了大量菜单，用于快速创建各类资源的代码骨架

快速开始

1. 创建项目

$ vona :create:project projectName
$ cd projectName

2. 修改.env 文件

env/.env:

# database
DATABASE_DEFAULT_CLIENT = 'sqlite3' # sqlite3/pg/mysql
DATABASE_CLIENT_PG_PASSWORD =
DATABASE_CLIENT_MYSQL_PASSWORD =

# redis
REDIS_DEFAULT_PASSWORD =

3. 启动开发服务

$ npm run dev

4. 单元测试

$ npm run test

5. 构建

$ npm run build

Docker Compose

$ npm run build:docker
$ sudo docker-compose build
$ sudo docker-compose up