vallezw/sheetable

SheetAble 镜像文档

镜像概述

SheetAble 是一款易于使用的自托管乐谱管理软件，专为音乐爱好者设计。它允许用户上传和组织各类乐器的乐谱，支持创建多用户账户，方便朋友或家人共享乐谱库，甚至共同上传乐谱。项目目标是实现跨设备支持，未来可在平板/iPad上对乐谱进行高亮或添加笔记。

!https://raw.githubusercontent.com/SheetAble/server/master/docs/SheetAbleShowcase.gif

核心功能与特性

• 自托管部署：可在个人服务器上部署，确保数据隐私与控制
• 多用户支持：创建独立账户，邀请朋友或家人访问乐谱库
• 乐谱组织管理：上传、分类和管理各类乐器的乐谱文件
• 跨设备目标：计划支持平板/iPad等设备，实现乐谱标注与笔记功能
• 技术栈：后端基于 Golang 开发，前端使用 React.js 构建

使用场景

• 个人乐谱管理：音乐爱好者整理个人乐谱收藏
• 家庭共享：家庭成员共享音乐学习资料与乐谱
• 音乐教学：教师与学生共享教学乐谱，协作学习
• 乐队协作：乐队成员共同管理和更新乐谱库

使用方法

快速开始

建议参考官方文档获取详细部署指南：SheetAble 官方文档

Docker 部署示例

基础运行命令

bash
docker run -d \
  --name sheetable \
  -p 8080:8080 \
  -v /path/to/your/sheets:/app/data \
  sheetable/server

说明：

• -v /path/to/your/sheets:/app/data：挂载本地目录用于持久化存储乐谱数据
• -p 8080:8080：映射容器端口到主机，可根据需要修改主机端口

Docker Compose 配置（示例）

yaml
version: '3'
services:
  sheetable:
    image: sheetable/server
    container_name: sheetable
    ports:
      - "8080:8080"
    volumes:
      - ./sheetable-data:/app/data
    restart: unless-stopped

贡献方式

欢迎通过以下步骤贡献代码或功能：

1. Fork 项目仓库
2. 创建特性分支：git checkout -b feature/AmazingFeature
3. 提交更改：git commit -m 'Add some AmazingFeature'
4. 推送到分支：git push origin feature/AmazingFeature
5. 打开 Pull Request

许可证

本项目采用 AGPL 许可证分发，详见 LICENSE 文件。

联系方式

• 作者：Valentin Zwerschke (https://github.com/vallezw)
• 项目地址：https://github.com/SheetAble

鸣谢

• Open Opus API：提供免费的古典音乐开放元数据