Usertour 开源项目教程

Usertour 开源项目教程

usertour Usertour is an open-source user onboarding platform designed for developers. It allows you to create in-app product tours, checklists, and launchers in minutes—effortlessly and with full control.The open-source alternative to Userflow and Appcues 项目地址: https://gitcode.com/gh_mirrors/us/usertour

1. 项目目录结构及介绍

Usertour 是一个开源的用户引导平台，它允许开发者快速创建应用内的产品引导、清单和调查。以下是项目的目录结构及其简要介绍：

usertour/
├── .husky/               # Husky 配置目录，用于 Git 钩子
├── apps/                 # 应用程序目录
├── assets/               # 资源目录，如图片、样式表等
├── nginx/                # Nginx 配置文件
├── packages/             # 包目录
├── scripts/              # 脚本目录
├── .env.example          # 环境变量示例文件
├── .gitignore            # Git 忽略文件
├── .npmrc                # npm 配置文件
├── CONTRIBUTING.md       # 贡献指南
├── Dockerfile            # Docker 构建文件
├── LICENSE               # 项目许可证文件
├── README.md             # 项目自述文件
├── biome.json            # 项目配置文件
├── docker-compose.yml    # Docker Compose 配置文件
├── package.json          # npm 包配置文件
├── pnpm-lock.yaml        # pnpm 锁文件
├── pnpm-workspace.yaml   # pnpm 工作空间配置文件
├── postcss.config.cjs    # PostCSS 配置文件
├── tsconfig.json         # TypeScript 配置文件
└── turbo.json            # Turborepo 配置文件

2. 项目的启动文件介绍

项目的启动主要通过 docker-compose.yml 文件来进行。以下是 docker-compose.yml 文件的基本内容：

version: '3'
services:
  usertour:
    build: .
    ports:
      - "8011:8011"
    volumes:
      - .:/usr/src/app
    environment:
      - NODE_ENV=development
    depends_on:
      - db
  db:
    image: postgres:12
    environment:
      - POSTGRES_USER=usertour
      - POSTGRES_PASSWORD=usertour
      - POSTGRES_DB=usertour

该文件定义了两个服务：usertour 和 db。usertour 服务是基于 Dockerfile 构建的，映射了本地端口到容器端口，并设置了环境变量。db 服务使用了 postgres 镜像，并设置了数据库的用户、密码和数据库名。

要启动项目，需要在项目根目录下执行以下命令：

docker-compose up -d

3. 项目的配置文件介绍

项目的主要配置文件是 .env.example，该文件包含了所有需要的环境变量及其默认值。以下是 .env.example 文件的部分内容：

# 数据库配置
DB_HOST=localhost
DB_PORT=5432
DB_USER=usertour
DB_PASS=usertour
DB_NAME=usertour

# 应用配置
APP_NAME=Usertour
APP_URL=http://localhost:8011

在正式部署时，需要根据实际环境创建一个 .env 文件，并覆盖 .env.example 中的默认值。确保所有敏感信息，如数据库密码，不要在版本控制系统中公开。

usertour Usertour is an open-source user onboarding platform designed for developers. It allows you to create in-app product tours, checklists, and launchers in minutes—effortlessly and with full control.The open-source alternative to Userflow and Appcues 项目地址: https://gitcode.com/gh_mirrors/us/usertour