Skip to content

Commit d1cd6f8

Browse files
committed
更新README:完善项目描述并添加官方网站链接
1 parent fac33ee commit d1cd6f8

File tree

1 file changed

+102
-51
lines changed

1 file changed

+102
-51
lines changed

README.md

Lines changed: 102 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,105 @@
1-
# React + TypeScript + Vite
2-
3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
4-
5-
Currently, two official plugins are available:
6-
7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
8-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
9-
10-
## Expanding the ESLint configuration
11-
12-
If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
13-
14-
```js
15-
export default tseslint.config({
16-
extends: [
17-
// Remove ...tseslint.configs.recommended and replace with this
18-
...tseslint.configs.recommendedTypeChecked,
19-
// Alternatively, use this for stricter rules
20-
...tseslint.configs.strictTypeChecked,
21-
// Optionally, add this for stylistic rules
22-
...tseslint.configs.stylisticTypeChecked,
23-
],
24-
languageOptions: {
25-
// other options...
26-
parserOptions: {
27-
project: ['./tsconfig.node.json', './tsconfig.app.json'],
28-
tsconfigRootDir: import.meta.dirname,
29-
},
30-
},
31-
})
1+
# LeetCode 爬虫与挑战贡献平台
2+
3+
![GitHub stars](https://img.shields.io/github/stars/JSREP/crawler-leetcode?style=social)
4+
![GitHub forks](https://img.shields.io/github/forks/JSREP/crawler-leetcode?style=social)
5+
![GitHub issues](https://img.shields.io/github/issues/JSREP/crawler-leetcode)
6+
![GitHub license](https://img.shields.io/github/license/JSREP/crawler-leetcode)
7+
8+
## 📖 项目简介
9+
10+
LeetCode 爬虫与挑战贡献平台是一个开源项目,旨在帮助开发者收集、整理和分享编程挑战题目。该平台提供了一套完整的工具,支持爬取LeetCode等平台的题目,并以统一的YAML格式进行存储和展示。
11+
12+
**🔗 访问在线网站: [https://jsrep.github.io/crawler-leetcode/](https://jsrep.github.io/crawler-leetcode/)**
13+
14+
![网站预览](path/to/screenshot.png)
15+
16+
## ✨ 主要功能
17+
18+
- 🔍 浏览各大编程平台的挑战题目
19+
- 🏷️ 按难度、标签、平台等多维度筛选题目
20+
- 📝 题目详情查看,包含完整描述、示例和解题思路
21+
- 🌐 支持中英文双语界面
22+
- 🤝 社区贡献功能,支持用户提交新题目
23+
- 📊 数据可视化展示,直观了解题目分布情况
24+
25+
## 🚀 快速开始
26+
27+
### 在线使用
28+
29+
直接访问我们的官方网站:[https://jsrep.github.io/crawler-leetcode/](https://jsrep.github.io/crawler-leetcode/)
30+
31+
### 本地开发
32+
33+
#### 前置条件
34+
35+
- Node.js 18+
36+
- npm 或 yarn
37+
38+
#### 安装步骤
39+
40+
1. 克隆仓库
41+
```bash
42+
git clone https://github.com/JSREP/crawler-leetcode.git
43+
cd crawler-leetcode
44+
```
45+
46+
2. 安装依赖
47+
```bash
48+
npm install
49+
#
50+
yarn install
51+
```
52+
53+
3. 启动开发服务器
54+
```bash
55+
npm run dev
56+
#
57+
yarn dev
3258
```
3359

34-
You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
35-
36-
```js
37-
// eslint.config.js
38-
import reactX from 'eslint-plugin-react-x'
39-
import reactDom from 'eslint-plugin-react-dom'
40-
41-
export default tseslint.config({
42-
plugins: {
43-
// Add the react-x and react-dom plugins
44-
'react-x': reactX,
45-
'react-dom': reactDom,
46-
},
47-
rules: {
48-
// other rules...
49-
// Enable its recommended typescript rules
50-
...reactX.configs['recommended-typescript'].rules,
51-
...reactDom.configs.recommended.rules,
52-
},
53-
})
60+
4. 构建生产版本
61+
```bash
62+
npm run build
63+
#
64+
yarn build
5465
```
66+
67+
## 🛠 技术栈
68+
69+
- **前端框架**: React 18
70+
- **类型系统**: TypeScript
71+
- **构建工具**: Vite
72+
- **UI组件库**: Ant Design
73+
- **国际化**: react-i18next
74+
- **状态管理**: React Context API
75+
- **路由管理**: React Router
76+
- **数据存储**: YAML格式
77+
78+
## 📋 贡献指南
79+
80+
我们欢迎社区成员为项目做出贡献!您可以通过以下方式参与:
81+
82+
1. **提交题目**: 通过平台的贡献功能,提交新的编程挑战题目
83+
2. **报告Bug**: 在GitHub Issues中提交问题报告
84+
3. **功能建议**: 提出新功能或改进意见
85+
4. **代码贡献**: Fork仓库,提交Pull Request
86+
87+
详细的贡献指南请参考 [CONTRIBUTING.md](./CONTRIBUTING.md)
88+
89+
## 📄 许可证
90+
91+
本项目采用 [MIT 许可证](./LICENSE)
92+
93+
## 🙏 致谢
94+
95+
感谢所有为本项目做出贡献的开发者和用户。
96+
97+
特别感谢以下开源项目:
98+
- [React](https://reactjs.org/)
99+
- [TypeScript](https://www.typescriptlang.org/)
100+
- [Vite](https://vitejs.dev/)
101+
- [Ant Design](https://ant.design/)
102+
103+
---
104+
105+
如有任何问题或建议,欢迎通过 [GitHub Issues](https://github.com/JSREP/crawler-leetcode/issues) 联系我们。

0 commit comments

Comments
 (0)