快速上手

TIP

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

前置条件

名称	版本
Nodejs	>=24.8.0
Redis	>=7.2.6
MySQL	>=8
Postgresql	>=17

• Redis: VonaJS 基于 Redis 提供了以下能力:
  • 队列、定时任务、启动项、广播、缓存、二级缓存、分布式锁
• MySQL/Postgresql: 选择一个你想用的

准备工作

1. 安装命令行工具

$ pnpm add -g tsx@latest
$ pnpm add -g vona-cli@latest

2. 安装 Vscode 插件：Vona - Official

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

快速开始

1. 创建项目

$ vona :create:project projectName
$ cd projectName

WARNING

在 Windows 中，需要使用管理员身份打开终端或者VSCode

2. 修改.env 文件

env/.env:

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

# redis
REDIS_DEFAULT_PASSWORD =

WARNING

对于开发环境和测试环境，建议使用系统默认的数据库名称，从而让系统自动创建测试数据库

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