# geektime-column-oh-my-kit

**Repository Path**: frank_develop/geektime-column-oh-my-kit

## Basic Information

- **Project Name**: geektime-column-oh-my-kit
- **Description**: 「哦我的工具箱（oh-my-kit）」项目基于Apache-2.0 协议开源，是一款集成了大量生产力工具的桌面 Web 应用软件，可以通过便捷的导航，轻松访问到趁手的、体验一致的工具。

此项目是极客时间专栏《现代 React Web 开发实战》模块三结尾的特别企划。

欢迎同学们加入到这个开源项目中，利用从专栏中学到的新版 React 知识和技术，扩展这一应用的功能，以巩固、提升学习效果。
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: http://gk.link/a/11Oax
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 13
- **Created**: 2023-01-01
- **Last Updated**: 2023-01-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# geektime-column-oh-my-kit

「哦我的工具箱（`oh-my-kit`）」项目基于[Apache-2.0 协议](./LICENSE)开源，是一款集（duī）成（qì）了大量生产力工具的桌面 Web 应用软件，可以通过便捷的导航，轻松访问到趁手的、体验一致的工具。

此项目是**极客时间**专栏《**_现代 React Web 开发实战_**》模块三结尾的特别企划。

专栏首页：[https://time.geekbang.org/column/intro/100119601](http://gk.link/a/11Oax)

欢迎同学们加入到这个开源项目中，利用从专栏中学到的新版 React 知识和技术，扩展这一应用的功能，以巩固、提升学习效果。

### 如何使用

开发环境需要 Node.js 16 LTS 版本。

1. 克隆项目仓库到本地 `git clone git@gitee.com:evisong/geektime-column-oh-my-kit.git`；
2. 进入项目目录 `cd geektime-column-oh-my-kanban`；
3. 安装 NPM 依赖 `npm install`；
4. 运行 NPM 脚本 `npm start`，浏览器会自动打开 [http://127.0.0.1:5173/geektime-column-oh-my-kit/](http://127.0.0.1:5173/geektime-column-oh-my-kit/)，展示应用。

#### 软件架构

请参考 [项目架构文档【docs/architecture.md】](./docs/architecture.md)。

### 参与贡献

#### 1. 提交 Bug 或 Feature Request

欢迎指出你在应用功能或技术层面发现的 Bug，也欢迎提出你希望应用加入的功能。

[【+ Issue】](https://gitee.com/evisong/geektime-column-oh-my-kit/issues/new)

#### 2. 贡献代码

步骤：

1. Fork 本仓库；
2. 基于最新的`main`分支，新建自己的`feat/xxx_yyy`分支；
3. 确认新加入的代码在本地可以正常运行，提交代码；
4. 新建拉取请求：[【+ Pull Request】](https://gitee.com/evisong/geektime-column-oh-my-kit/pull/new)；
5. 根据 PR 中的评审意见，发起讨论并对代码进行必要的调整；
6. PR 被合并到`main`分支后，会被部署在[Gitee Pages](https://evisong.gitee.io/geektime-column-oh-my-kit/)。

对代码的一些建议：

- React 代码优先使用函数组件和 Hooks，减少类组件使用；
- 目前项目同时支持 TS 和 JS，选用自己熟悉的语言即可；
- 提倡保持代码简洁，变量名清晰，避免面条代码；
- 无需纠结代码格式，交给 ESLint 和 Prettier 就好自动格式化就好；
- 尽量基于项目现有的依赖包进行开发，避免额外引入第三方库；
- 尽量避免复制粘贴第三方代码，如确实需要请标明出处；
- 虽然目前还不统计测试覆盖率，但非常欢迎加入单元测试和 E2E 测试。

#### 注意事项

应平台要求，禁止提交以下违规内容：

- 禁止发布诱导分享/诱导关注/诱导下载/诱导跳转内容
- 禁止发布欺诈/谣言/骚扰信息/广告信息/垃圾信息/特殊识别码、口令类信息
- 禁止发布低俗内容/“宗教性捐献”及相关信息
- 禁止发布侵害他人权利/违法经营及可疑服务类内容
- 禁止发布其它违反国家法律法规的内容

如果在 Issue 或 PR 中包含违规内容，项目维护者有权代为修改或删除。