briefkasten

？ hivekasten

hivkasten （en：邮箱） - haus -oder wohnungseingang angebrachter behlterfürdemempfängerempfängerzugestellten [post] sendungen

自主书签应用程序。与任何兼容数据库（MySQL，Postgres，Sqlite等）一起使用

警告

hithkasten v2目前可在beta上找到，网址为https://dev.briefkastenhq.com

在Beta期间之后，数据库将被删除，以便我们可以将当前（V1）简介briefkastenhq.com迁移到新版本。我已经在新文档上工作了，但是V1文档当然仍然可用。如果您发现任何错误或其他想帮助，则可以在ndom91/sveltekasten或ndom91/briefkasten-docs上贡献。

免费实例：hivekastenhq.com [docs]

？屏幕截图

？特征

• 由浏览器扩展节保存
• 自动标题和说明提取
• 页面上的拖放URL保存
• 键盘快捷键
• 按类别和标签组织
• 来自标准HTML格式的导入和导出书签
• 书签图像获取背景工作
• 多个视图
• 完整搜索
• REST API
• Oauth +电子邮件魔术链接登录

？先决条件

要自助托管此应用程序，您将需要以下细分：

1. Next.js应用程序的服务器 /托管平台（即Vercel / Netlify）
2. 对于Oauth Login，NextAuth.js支持的任何一个提供商的开发人员帐户
3. 与Prisma一起使用的数据库（即MySQL，Postgres，Sqlite等）
4. 图像托管空间（即supabase / imagekit / cloudinary）（可选）

除了图像霍斯特，这些都是相对直截了当的。选择这是为了避免将图像放在数据库中。 hivekastenhq.com上的示例应用程序正在使用supabase Storage，但是任何其他类似的提供商（例如Cloudinary或Simple S3 Bucket）也可以完成这项工作。我之所以选择supabase，是因为它们具有易于使用的SDK，一个不错的免费层，而且我已经在使用他们的Postgres服务。

在所有上述提供商中都有帐户设置，或者准备好自己的基础架构后，您可以继续执行以下下一步。

入门

1. 克隆存储库

$ git clone [email protected]:ndom91/briefkasten.git && cd briefkasten

2. 安装依赖项

$ pnpm install

3. 将.env.example文件复制到.env ，并使用您喜欢的文本编辑器将其打开以填充您的环境变量。

$ cp .env.example .env
$ vim .env

在此环境变量文件中，请确保至少填写DATABASE_URL ， NEXTAUTH_URL和NEXTAUTH_SECRET 。其余的环境变量取决于您要使用的服务 /功能。例如，用于OAUTH登录和/或SUPABASE的Google/github用于对象存储。

4. 启动服务器！

// First time only
$ pnpm db:push

// dev
$ pnpm dev

// prod
$ pnpm build
$ pnpm start

？ Docker

您也可以与Docker一起自主主持人。为此，您必须：

1. 安装docker和docker-compose 。
2. 克隆存储库，然后将.env.example复制到.env文件。
   1. 在这里，您还需要至少填写DATABASE_URL和NEXTAUTH_*环境变量。
   2. Postgres容器的DATABASE_URL应该是DATABASE_URL=postgres://bkAdmin:briefkasten@postgres:5432/briefkasten?sslmode=disable
3. 在存储库的根部运行docker-compose up -d 。这将为您启动应用程序以及数据库。
4. 初始开始后，您仍然必须手动播种数据库。这是通过应用程序容器（ bk-app ）最容易完成的。
   1. 运行docker exec -it bk-app /bin/bash以在容器内输入终端会话。
   2. 然后运行pnpm db:push 。这将将数据库架构从PRISMA推到配置的数据库。
5. 现在，您的应用程序和数据库应在默认的http://localhost:3000启动并运行

可以在文档的“ Docker”部分中找到更多详细信息。

？有关的

？从Android共享菜单中保存

使用此开源应用程序HTTP快捷方式，您可以创建一个“共享菜单”项目，该项目可以执行具有动态输入的POST请求，即网页的URL和标题。这使得从手机到Shipkasten的商品非常容易！文档中的更多信息。

？浏览器扩展

工作中有一个伴随浏览器扩展程序，您可以在浏览网络时将其添加到保险库中。它可以在ndom91/briefkasten-extension和CHROME扩展商店中找到。该存储库中的更多详细信息。

？‍？屏幕截图工作

还有一个背景工作可以填写没有有效图像的书签。它可以在ndom91/briefkasten-scrape存储库中找到。这项工作每2个小时在GitHub动作中运行一次，并一次处理10个书签。

？贡献

该项目对所有贡献都开放！请坚持使用Eslint /更漂亮的设置，我很乐意看看您的问题 / PR？

执照

麻省理工学院