Skip to content
This repository has been archived by the owner on Jan 3, 2024. It is now read-only.

CaoMeiYouRen/shirakami-haruka-button-ssr

Repository files navigation

shirakami-haruka-button-ssr (豹按钮(:3っ)∋)

Version GitHub Workflow Status Documentation Maintenance License: MIT

本项目为 豹按钮(:3っ)∋ 的 SSR 版本,功能完全一致。

关于 SSR 是什么详见:Vue.js 服务器端渲染指南

温馨提示:由于 cdn.jsdelivr.net 在中国大陆地区曾经被封禁过,可靠性不高,故移除了自动设置的 CDN_PATH,现在的音声会默认从本地加载。如有 CDN 加速需求请自行设置 CDN_PATH

🏠 主页

演示页面

https://ssr.haruka.fun/

依赖要求

  • node >=12

安装

npm install

开发

npm run dev

然后请打开 http://localhost:7000 查看效果

新增音声

所有音频文件统一放在 static/voices 文件夹下,格式最好为 mp3,或者其他能在 Chrome 浏览器中正常播放的音频格式。

文件名称最好为音频内容,如果太长可以简略。

所有音频在 src/config/voices.ts 中配置,只要增加符合以下格式的对象即可,相同的 tag 最好放在一起配置

interface VoiceInfo {
    /**
     * 标题翻译
     */
    messages: {
        zh: string
        en?: string
        ja?: string
    }
    /**
     * 音声路径。相对于 public/voices 的路径
     */
    path: string
    /**
     * 分类标签,i18n 路径。会根据这个 tag 进行分类,tag 的翻译在 locales 文件夹下 zh/en/ja 文件中的 tags 字段中设置
     */
    tag: string
}

例如:

 {
     messages: {
         zh: '阿巴阿巴阿巴阿巴阿巴阿巴阿巴阿巴阿巴阿巴',
         en: 'aba aba aba aba aba aba aba aba aba',
         ja: 'アルバアバアバアバアバアバアバアバアバアバアバ'
     },
     path: '阿巴阿巴阿巴.mp3',
     tag: 'Tone',
 }

二次开发

本项目为 MIT 开源项目,因此可在协议范围内随意使用源码。下面是关于二次开发的注意事项。

  1. 修改环境变量:修改根目录 .env 即可,已经提取了大部分配置,具体说明见注释。
  2. 修改主题色:除了修改 .env 文件中的变量外,还需修改 src/styles/index.scss 文件下的 $primary-color 变量。
  3. 修改 Home.vue 文件:Home.vue 中含有一部分项目说明,请自行改动。
  4. 修改 src/components 下的组件名称:由于设计上的问题,组件名称是带了 vup 的名字,所以请自行修改为不带名字的组件或改成对应的 vup。
  5. 其他细节上的问题请自行调整~

Pull Request

**注意:**请提交 PR 时提交到 dev 分支,master 分支暂不接受 PR。

编译

npm run build

Lint

npm run lint

commit

本项目遵从严格的 git commit 约束,这将用于自动化生成日志,所以请勿直接提交 git commit。

本项目使用 cz-conventional-changelog 工具来生成 git commit,使用 husky 约束 git commit

npm run commit 
#请勿直接提交git commit
#若觉得修改太多也可分开提交。先 git add 一部分,执行 git cz 提交后再提交另外一部分

关于选项,参考 semantic-release 的文档

  • 若为BUG修复,则选择 fix
  • 若为新增功能,则选择 feat,新增音声可以按这个提交。
  • 若为移除某些功能,则选择 perf 或填写 BREAKING CHANGE
    • perf 和其他破坏性更新,若不是为了修复BUG,原则上将拒绝该PR

友链

本项目十分欢迎交换友链,若你也想加入友链可以在 issue 中提出。如果有人使用了本项目作为模板,也欢迎告知,本人也会考虑将你的网站加入友链。

作者

👤 CaoMeiYouRen

🤝贡献

欢迎Contributions, issues and feature!
如有问题请查看 issues page.

支持

如果觉得这个项目有用的话请给一颗⭐️,非常感谢

📝 License

Copyright © 2020 CaoMeiYouRen.
This project is MIT licensed.


This README was generated with ❤️ by readme-md-generator