Hacklily 开源项目教程

凤高崇

于 2024-09-25 08:54:37 发布

阅读量895

点赞数 7

本文链接：https://blog.csdn.net/gitblog_01130/article/details/142513628

版权

Hacklily 开源项目教程

hacklily A web-based sheet music editor and publishing platform. 项目地址: https://gitcode.com/gh_mirrors/ha/hacklily

1. 项目介绍

Hacklily 是一个基于 Web 的乐谱编辑器和发布平台。它使用 Monaco 编辑器（即 VSCode 使用的编辑器）作为前端，并使用 Lilypond 作为后端渲染器。Hacklily 可以直接将乐谱发布到 GitHub，非常适合音乐创作者和开发者使用。

2. 项目快速启动

2.1 依赖安装

在本地运行 Hacklily 之前，您需要安装以下依赖：

Node.js（推荐使用 Node 7 或更高版本）
Yarn
Qt 5（确保 qmake 在您的 PATH 中）
Docker

2.2 获取项目

首先，克隆 Hacklily 的代码库：

git clone https://github.com/jocelyn-stericker/hacklily.git
cd hacklily

2.3 运行项目（无 GitHub 集成）

如果您不需要 GitHub 集成，可以直接运行以下命令启动 Hacklily：

make serve

2.4 运行项目（带 GitHub 集成）

如果您需要测试与 GitHub 的集成，请按照以下步骤操作：

创建一个 GitHub 组织。
在 GitHub 组织中创建一个新的应用，并记下客户端 ID 和密钥。

在终端中运行以下命令启动前端：

cd hacklily
yarn env \
  REACT_APP_GITHUB_CLIENT_ID=your_github_api_client_id_here \
  REACT_APP_BACKEND_WS_URL=ws://localhost:2000 \
  yarn start

在另一个终端中运行以下命令启动后端：

cd hacklily/server
mkdir build
cd build
qmake ../ws-server
make
./ws-server \
  --renderer-path ../renderer \
  --renderer-docker-tag hacklily-renderer \
  --github-client-id your_github_api_client_id_here \
  --github-secret your_github_api_secret_here \
  --ws-port 2000

完成后，您可以在浏览器中访问 http://localhost:3000 查看 Hacklily 应用。