Skip to content

Y80/bmm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

94 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


BMM

收纳、分享、探索优质网站

BMM / bookmark manager / 你的专属书签管家

PC 端明亮/暗夜主题 后台管理 移动端 AI 解析网站

✨ 功能

基本功能:

  • 支持移动端/桌面端、明亮主题/暗夜主题
  • 搜索书签、标签
  • 标签和标签、书签和标签间的相互关联
  • Github 授权登录、账号密码登录
  • 登录用户可管理自己的书签、标签

后台管理功能:

  • 导入浏览器导出的书签
  • 标签、书签的增删改查
  • 标签间的相互关联
  • 标签和书签的相互关联
  • 标签排序
  • 爬取网站标题、图标、简介,多个 API 获取网站图标
  • AI 智能解析网站标题、图标、简介、关联标签
  • AI 为标签关联标签

待实现:

  • 多功能卡片,支持展示天气、资讯...
  • 浏览器插件
  • 服务端、客户端检测书签可用性
  • 稍后阅读系统

🧑‍💻 本地开发

  1. git 克隆项目至本地 git clone https://github.com/Y80/bmm.git

  2. 安装依赖 pnpm install

  3. 启动项目 pnpm dev

环境变量

具体的环境变量配置可以参考 .env

若您只是想快速体验项目,本地拉取项目后,无需修改任何环境变量即可启动开发服务器(数据库用的是本地 SQLite)。

若您需要部署到服务器上,重点关注 AUTH_URL 和数据库相关变量配置。

🗄️ 数据库

BMM 使用 Drizzle ORM 持久化存储数据,当前开箱即用的支持 SQLite 和 PostgreSQL 数据库。

默认的配置使用本地的 SQLite 数据库,通过 pnpm dev 可在本地自动创建数据库文件,并供本地开发服务器使用。

若需部署到线上,需要使用线上数据库,这里提供两篇文档以便您能快速、免费获取线上数据库资源:

  1. BMM 接入 Turso
  2. 一些免费的 PostgreSQL 数据库

您也可以使用自己的数据库云服务。

🚀 项目部署

方式一:Node 项目常规部署

  1. 通过 git clone 或其他方式将项目复制到服务器上

  2. 安装依赖 pnpm install

  3. 构建项目 pnpm build

  4. 启动生产环境服务器 pnpm start;若您使用了 PM2,可通过 pm2 start "pnpm start" 启动项目。

方式二:部署至 Vercel

  1. fork 当前 Github 仓库

  2. 登入 Vercel,新建项目,并关联 fork 的 Github 仓库

  3. 在当前项目下的 Environment Variables 页面中配置环境变量

查看截图

vercel-settings-env

Vercel 上每个项目都会被自动分配一个域名,如 bmm.vercel.app,如果你最终使用这个域名访问 BMM 服务,那么可以不用配置 AUTH_URL,否则必须配置该环境变量。

  1. 在 「Deployments 面板」再重新部署一下即可

方式三:使用 Docker 部署

# 拉取镜像
docker pull lcclcc/bmm

# 启动容器(使用本地 SQLite, 通过 docker volume bmm 查看数据库文件地址)
docker run --rm  \
-e DB_DRIVER=sqlite \
-e DB_CONNECTION_URL=file:/app/volume/sqlite.db \
-v bmm:/app/volume \
-p 3000:3000 \
lcclcc/bmm \
pnpm start

# 启动容器(使用 Turso )
docker run --rm  \
-e DB_DRIVER=sqlite \
-e DB_CONNECTION_URL=libsql://Turso数据库地址  \
-e DB_AUTH_TOKEN=<Turso数据库令牌> \
-p 3000:3000 \
lcclcc/bmm \
pnpm start

# 启动容器(使用 PostgreSQL )
docker run --rm  \
-e DB_DRIVER=postgresql \
-e DB_CONNECTION_URL=postgresql://数据库地址 \
-p 3000:3000 \
lcclcc/bmm \
pnpm start

🤖 接入 AI 服务(可选)

本项目通过 AI 实现了 分析总结网站、给网站打标签、分析相关联的标签 的功能,可大大减少维护书签数据的工作量。

由于目前 AI 服务商众多,且不同服务商提供的 API 并不相同,因此这里会有轻微的编码工作。

下面是使用 字节跳动-扣子 AI 能力的示例:

export const getServer = coze

function coze() {
  if (!env.COZE_API_KEY || !env.COZE_BOT_ID) {
    throw new Error('请配置环境变量 COZE_API_KEY、COZE_BOT_ID')
  }
  return {
    responseContentPath: 'messages[0].content',
    sendRequest(query: string) {
      return commonFetch({
        url: 'https://api.coze.cn/open_api/v2/chat',
        token: process.env.COZE_API_KEY!,
        body: {
          bot_id: process.env.COZE_BOT_ID,
          user: 'user',
          query,
          stream: false,
        },
      })
    },
  }
}

src/lib/ai/servers.ts 文件提供了使用 扣子OpenAI 的代码示例可供参考。

接入 Github 授权登录(可选)

BMM 支持使用 Github 授权登录,配置 Github OAuth 即可实现。

查看创建步骤
  1. 登录您的 Github 账户后,访问 https://github.com/settings/applications/new

  2. 依次填写表单内容

其他内容可随意填写,最重要的是 Authorization callback URL 这一项,请保证它和你的项目最终部署的 线上访问地址 一致!

  1. 创建一个 Client secret

Github OAuth App 的 Client ID 和 Client Secret 将分别用作环境变量 AUTH_GITHUB_IDAUTH_GITHUB_SECRET,填写的 Authorization callback URL 要和环境变量 AUTH_URL 保持一致。

🤔 常见问题

如何设置环境变量 AUTH_URL 和 Github 中的 Authorization callback URL?
首先需要明确, AUTH_URL 和 Github OAuth App 中的 Authorization callback URL 是一致的,用于指定用户在 Github 确认授权后,浏览器需要重定向的服务器地址。
它们的值如何设定,简单来说,通过什么地址访问 BMM 服务,就把该地址作为它们的值,例如:
Github 登录失败:redirect_uri 错误
如果在 Github 授权之后出现如下错误提示:

github-redirect-uri-error

这表示授权之后 Github 需要跳转的地址和 Github:OAuth Apps 中的配置不一致。

请保证下方配置的 Authorization callback URL 和你访问的域名地址、 AUTH_URL 一致。

github-oauth-cb-url

修改了项目端口后,Github 授权登录回调地址的端口有误
如果你修改了项目端口,并通过 http://{IP}:{PORT} 的方式访问 bmm,那你也需要修改环境变量 AUTH_URL
再次明确:访问项目的地址、Authorization callback URL、AUTH_URL 这三者应该是一致的。
支持其他数据库吗?
借助 drizzle-orm 的能力,本项目可以快速接入 MySQL 数据库。