Skip to content

快速上手

准备工作

  1. 安装命令行工具
bash
$ pnpm add -g tsx@latest
$ pnpm add -g vona-cli@latest
  1. 安装 Vscode 插件:Vona - Official

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

快速开始

  1. 创建项目
bash
$ vona :create:project projectName
$ cd projectName
  1. 修改.env 文件

env/.env:

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

# redis
REDIS_DEFAULT_PASSWORD =
  1. 启动开发服务
bash
$ npm run dev
  1. 单元测试
bash
$ npm run test
  1. 构建
bash
$ npm run build

Docker Compose

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

基于 MIT 许可发布