Home
Guide
API
Develop
Plugins
Roadmap
Contribution
Home
Guide
API
Develop
Plugins
Roadmap
Contribution

快速开始（源码）

0.先决条件

请确保你已经：

  • 安装了 Node.js 20.18.0 及以上版本 + pnpm 10.12.1
$ node -v 
v20.18.0
$ pnpm -v
10.12.1

1.安装项目

git clone https://github.com/tachybase/tachybase.git

2. 切换目录

cd tachybase

3. 安装依赖

📢 由于网络环境、系统配置等因素影响，接下来这一步骤可能需要十几分钟时间。

pnpm install

4. 设置环境变量

Tachybase 所需的环境变量储存在根目录 .env 文件里，根据实际情况修改环境变量，如果你不知道怎么改，点此查看环境变量说明，也可以保持默认。

TZ=Asia/Shanghai
APP_KEY=your-secret-key
DB_DIALECT=postgres
DB_HOST=localhost
DB_PORT=5432
DB_DATABASE=postgres
DB_USER=tachybase
DB_PASSWORD=tachybase
  • TZ 用于设置应用的时区，默认为操作系统时区；
  • APP_KEY 是应用的密钥，用于生成用户 token 等（如果 APP_KEY 修改了，旧的 token 也会随之失效）。它可以是任意随机字符串。请修改为自己的秘钥，并确保不对外泄露；
  • DB_* 为数据库相关，如果不是例子默认的数据库服务，请根据实际情况修改。

5. 初始化灵矶

pnpm tachybase install --lang=zh-CN

6. 启动灵矶

pnpm dev

7. 访问灵矶

使用浏览器打开 http://localhost:3000 初始化账号和密码是 [email protected] 和 !Admin123.。

其他说明

由于国内网络环境的原因，强烈建议你更换国内镜像。

$ pnpm config set disable-self-update-check true
$ pnpm config set registry https://registry.npmmirror.com/
$ pnpm config set sqlite3_binary_host_mirror https://npmmirror.com/mirrors/sqlite3/
Total visits  times     Total visitors  times     Total reading  times.   Powered by Tego Team