Beam.Cafe 开源项目教程

Beam.Cafe 开源项目教程

beam.cafe 🌠 Blazing fast file transfer app focused on user-experience. Fastest way to share files without uploading them. 项目地址: https://gitcode.com/gh_mirrors/be/beam.cafe

1. 项目介绍

Beam.Cafe 是一个专注于用户体验的超快速文件传输应用程序。它允许用户在不将文件上传到服务器的情况下，直接从本地机器分享文件。Beam.Cafe 的主要特点包括：

• 即时传输：文件传输速度极快，无需上传到未知服务器。
• 匿名性：Beam.Cafe 对用户的了解非常有限，仅知道文件名和 IP 地址。
• 流式传输：支持流式传输，适用于大型文件如电影、图片和音频文件。
• PWA 支持：可以作为渐进式 Web 应用程序安装在桌面和手机上。
• 多主题：支持亮主题和暗主题，甚至高对比度模式。
• 可访问性：高对比度主题和现代的 aria-labels 使得使用更加便捷。

2. 项目快速启动

2.1 克隆项目

首先，克隆 Beam.Cafe 的前端和后端仓库：

git clone https://github.com/dot-cafe/beam.cafe
git clone https://github.com/dot-cafe/beam.cafe.backend

2.2 安装依赖

进入前端和后端目录，分别安装依赖：

cd beam.cafe
npm install

cd ../beam.cafe.backend
npm install

2.3 启动项目

在前端和后端目录分别启动项目：

cd beam.cafe
npm run dev

cd ../beam.cafe.backend
npm run dev

前端将在 3000 端口运行，后端将在 8080 端口运行。确保这些端口在你的机器上是开放的。

2.4 使用 Docker 部署

Beam.Cafe 也可以使用 Docker 进行部署：

mkdir beam.cafe && cd beam.cafe

curl -sSL https://raw.githubusercontent.com/dot-cafe/beam.cafe/master/docker-compose.yml > docker-compose.yml
curl -sSL https://raw.githubusercontent.com/dot-cafe/beam.cafe/master/.env.example > .env

mkdir config && echo "[]" > config/backend.json

确保更新 .env 文件中的变量，然后启动 Docker 容器：

docker-compose up -d

3. 应用案例和最佳实践

3.1 文件共享

Beam.Cafe 非常适合需要快速、安全地共享文件的场景。例如，团队成员可以在不使用第三方服务的情况下，直接从本地机器分享大型设计文件或代码库。

3.2 流媒体传输

对于需要传输大型媒体文件（如电影、音频文件）的场景，Beam.Cafe 的流式传输功能可以显著减少传输时间和带宽消耗。

3.3 匿名文件传输

在需要保护用户隐私的场景中，Beam.Cafe 的匿名性特点使得用户可以放心地分享文件，而不必担心个人信息泄露。

4. 典型生态项目

4.1 Preact

Beam.Cafe 的前端使用了 Preact，这是一个轻量级的 React 替代方案，提供了高性能和较小的包大小。

4.2 Graceful-WS

Graceful-WS 是一个用于 WebSocket 的库，Beam.Cafe 使用它来处理 WebSocket 连接，确保在各种网络条件下都能稳定运行。

4.3 Nanopop

Nanopop 是一个极小的弹出窗口库，Beam.Cafe 使用它来实现用户界面中的弹出提示和通知。

通过这些生态项目的结合，Beam.Cafe 提供了一个高效、可靠的文件传输解决方案。

beam.cafe 🌠 Blazing fast file transfer app focused on user-experience. Fastest way to share files without uploading them. 项目地址: https://gitcode.com/gh_mirrors/be/beam.cafe