/picx

🏞️ PicX 是一款基于 GitHub API 开发的图床工具,提供图片上传托管、生成图片链接和常用图片工具箱服务。

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

PicX

PicX

Release License Stars Issues Deploy

PicX 是一款基于 GitHub API 开发的图床工具,提供图片上传托管、生成图片链接和常用图片工具箱服务。


亮点 | Highlights

  • 在线使用、无需下载、无需安装。
  • 操作简单、文档完善、持续维护。
  • 代码开源、数据安全、完全免费。

如何使用 | How to use

通过 GitHub OAuth 授权填写 GitHub Token 登录到 PicX,完成 图床配置 后即可使用。

在线使用入口 https://picx.xpoet.cn

重要提示:

  • 为进一步简化用户操作,PicX 自 v3.0 起,不再支持自由选择仓库和分支,统一使用内置的仓库和分支。
  • 如需继续使用自定义的仓库和分支,请使用 PicX v2.0

命令

安装 node 版本

nvm install 20

使用 pnpm 安装所有依赖

pnpm install

启动开发服务器

pnpm dev --host

构建项目

pnpm build

预览构建结果

pnpm serve --host

项目中已经配置了 Commitizen,可以帮助你生成符合规范的提交信息。使用以下命令来提交代码:

npx cz

文档 | Documents

官方文档 https://picx-docs.xpoet.cn

通过阅读 快速开始 教程,可帮助你迅速上手 PicX。

功能 | Features

贡献 | Contribution

欢迎各种形式的贡献,包括但不限于:美化界面、增加功能、性能优化、修复 Bug、完善文档等。

参与贡献必读:PicX 贡献指南

致谢

这个项目的存在多亏了所有的贡献者,在此表示感谢。

反馈 | Feedback

在使用过程中,如遇问题,请仔细阅读 官方文档,或在 GitHub 发起 Issue

赞赏 | Appreciation

PicX 的更新迭代依靠作者工作之外的时间,维护不易,如果对你有帮助,可以赞赏作者,支持开源。

许可 | License

AGPL-3.0

Copyright © 2020-Present XPoet