ITADN
MarsHeer/offtiktokapi
README.md
以下内容由 AI 翻译,如有问题请点此提交 issue 反馈

Offtiktok | 开源 TikTok 客户端

Offtiktok 允许用户在 URL 中于 "tiktok" 前添加 "off"(例如:https://vm.offtiktok.com/ZGe7XpCwV/ ),从而与任何人分享 TikTok 视频,无论对方是否安装了该应用。

它还包含一个极简主义的 TikTok 信息流,允许观看平台推荐的视频,无广告、无应用、无地理限制。

本仓库包含后端服务器。如果您正在寻找前端,它在这里

自行部署

该后端使用 node.js 构建,可以相当简单地部署:

使用 Docker

1. 配置您的 .env

创建一个 .env 文件,并复制仓库中包含的 .env.template 文件的内容。

为您的 prisma DB 命名

2. 启动容器

  • 初始化为运行 ./docker-up.sh 的 docker 容器
  • 如果脚本因权限设置而失败,请运行 chmod +x ./docker-up.sh 然后再次运行该脚本。

在您自己的机器上

1. 安装 Node & npm(或您首选的包管理器)

macOS
  1. 使用 Homebrew

    • 如果您尚未安装,请安装 Homebrew:

        /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
      
  • 安装 Node.js 和 npm: brew install node brew install node
  1. 使用 Node Version Manager (nvm)

    • 安装 nvm

        curl  -o-  https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
      
  • 加载 nvm:

    ```
    export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s
    "${XDG_CONFIG_HOME}/nvm")"
    [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
    ```
    
  • 安装 Node.js:

    ```
    nvm  install  node
    ```
    
Linux
  1. 使用 NodeSource 二进制文件

    • 安装 Node.js 和 npm:

      curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
      sudo apt-get install -y nodejs
      
  2. 使用 Node Version Manager (nvm):

    • 安装 nvm:

        curl  -o-  https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
      
  • 加载 nvm:

    ```
    export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s
    "${XDG_CONFIG_HOME}/nvm")"
    [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
    ```
    
  • 安装 Node.js:

    `nvm  install  node`
    
Windows
  1. 使用 Node.js 安装程序

    • 从 Node.js 网站下载 Windows 安装程序。
    • 运行安装程序并按照提示操作。
  2. 使用 Windows 版 Node 版本管理器(nvm-windows)

    • 从 nvm-windows 发布页下载并安装 nvm-windows
    • 安装 Node.js:
      nvm  install  latest
      nvm  use  latest
      

安装完成后,通过运行以下命令验证 Node.js 和 npm 是否已正确安装:

node  -v
npm  -v

2. 安装依赖

要安装项目依赖项,请运行:npm install

3. 配置你的 .env

创建一个 .env 文件,并复制仓库中提供的 .env.template 文件的内容。

为你的 prisma 数据库命名

4. 应用 prisma 迁移

在首次开发运行之前,你需要应用 prisma 迁移,请运行:npx prisma migrate dev

5. 准备开发!

运行 npm run dev 以在端口 2000 上启动你的开发服务器

其他脚本和重要步骤

该仓库还包含 npm run buildnpm run start 脚本。 这些脚本旨在用于生产服务器, npm run build 将编译你的 typescript 并应用任何缺失的 prisma 迁移。 npm run start 将在你的服务器上启动编译后的 index.ts

需要服务持久化和启动脚本等功能?查看 pm2

协作

欢迎协作!请随时通过提交 issue 或 pull request 来支持该项目

许可证

本项目采用 MIT 许可证