Moments 开源项目使用教程

Moments 开源项目使用教程

moments 极简朋友圈 项目地址: https://gitcode.com/gh_mirrors/mom/moments

1. 项目介绍

Moments 是一个开源的极简朋友圈项目，采用 Golang 重写服务端，旨在提供更高效、更小的包体积以及更强大的功能。项目支持多用户模式、Memo 记录、标签管理、图片上传、Markdown 语法、点赞与评论等特性。同时，它完美适配移动端，支持暗黑模式，并提供了丰富的自定义选项。

2. 项目快速启动

环境准备

• 后端：Go 1.22.5+
• 前端：NodeJS 18+，推荐使用 PNPM

启动步骤

2.1 使用 Docker

• 启动容器（需替换 $JWT_KEY）：

docker run -d \
-e PORT=3000 \
-e JWT_KEY=$JWT_KEY \
-p 3000:3000 \
-v /var/moments:/app/data \
--name moments \
kingwrcy/moments:latest

• 持久化数据：/app/data 挂载至 /var/moments

• 可选版本：latest（稳定版）或 dev（开发版，功能前沿但相对不稳定）

2.2 使用 Docker Compose

services:
  moments:
    image: kingwrcy/moments:latest
    container_name: moments
    restart: always
    environment:
      PORT: 3000.0.0.0:3000
      JWT_KEY: $JWT_KEY
    ports:
      - 3000:3000
    volumes:
      - /var/moments:/app/data

2.3 可执行文件安装

• 下载最新版本示例（Windows 版）：

  • 文件名：moments-windows-amd64-x.x.x.exe.zip（压缩包，解压后可直接运行）
  • 文件名：moments-windows-amd64-x.x.x.exe-checksum.txt（MD5 校验码，验证文件完整性）

• 生成 JWT_KEY：

  • 方法 1：OpenSSL openssl rand -hex 32
  • 方法 2：SHA256 echo $RANDOM | sha256sum
  • 方法 3：在线生成（生成 UUID）

2.4 开发环境启动

• 使用 make（推荐）

  后端：

  cd moments
  make backend-dev
  

  前端（新终端）：

  cd moments
  make frontend-install
  make frontend-dev
  

• 手动运行

  后端：

  cd moments/backend
  go build -ldflags "
  -X main.version=local -X main.commitId=local
  " -o ./dist/moments
  ./dist/moments
  

  前端：

  cd moments/front
  pnpm install
  pnpm run dev
  

• 启动后访问 http://localhost:3000

3. 应用案例和最佳实践

（此部分内容需要根据实际项目使用场景和用户反馈来编写，以下为示例内容）

• 多用户模式：企业内部社交平台，支持多用户交流，提高团队协作效率。
• Memo 记录：个人知识库构建，记录重要信息和灵感。
• 图片上传与缩略图：在线相册功能，自动生成缩略图，便于图片管理和预览。

4. 典型生态项目

（此部分内容需要根据项目生态和相关项目来编写，以下为示例内容）

• 类似项目：RandallAnjie/moments，提供在线演示和不同实现方式。
• 关联工具：使用 Go 开发的其他社交平台工具，如评论系统、聊天室等。
• 社区资源：Moments 在 GitHub 上拥有活跃的社区，提供问题解答和功能改进建议。

moments 极简朋友圈 项目地址: https://gitcode.com/gh_mirrors/mom/moments