Skip to content

Latest commit

 

History

History
85 lines (57 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

85 lines (57 loc) · 2.74 KB

贡献指南

欢迎你参与贡献!在此之前请先阅读本文。

启动项目

安装依赖:

$ yarn
# Or
$ npm i

启动项目:

$ yarn run dev

项目启动后,在浏览器中打开 http://127.0.0.1:3000 即可。

如果要更新 Native App 仓库,可以运行:

$ yarn run build:cap

环境变量

Name Description
RESEND_API_KEY Your Resend key. Used to send feedback to your email

添加一个工具

/src/apps下创建一个以工具名命名、采用小蛇型命名法的目录,并在根目录创建一个README.zh-CN.md文件,该文件的头部描述工具信息,内容则会展示给用户。

示例如下:

---
name: "日期&时间计算"
status: "stable"
icon: "/icon/Google_Calendar_icon_(2020).svg"
description: "计算两个日期间隔的天数和时间,或推算几天前后是哪一天,可以算算你活了多久"
channel: life
freeSize: true
---

这里是帮助文本,提供必要的说明。

属性表格:

属性名 类型 描述 是否必填
name string 工具名
status string 工具状态,可选值为stablebetaalpha
icon string 工具图标路径
description string 工具描述
channel number 工具所属频道,可选值为lifeaimedia4
freeSize boolean 消除默认的居中样式

接着,在appEntry.ts中,根据已有的示例,添加引入函数。完成。

之后,你可以像开发常规 react app 一样编写代码。在components文件夹中有一些预先写好的组件。

翻译

除工具文档之外,网站所有的需要翻译的字段都位于/src/data/i18n/i18n.xlsx这个表格中。你可以打开自由编辑。

编辑完成后,请先提交 Pull Request,代码审查完后,你可以运行yarn run i18n:update命令输出 json 格式文件。

目前需要翻译的语言有:

  • 繁体中文(香港)
  • English
  • Francis

提交新设计

如果你有新的设计创意,可以把设计原型提交在这个issue中。

修复 bug & 改进功能