Skip to content

Commit ec2c465

Browse files
hackathon-chathackathon-chat
committed
feat: update
1 parent 5f975b5 commit ec2c465

File tree

2 files changed

+293
-31
lines changed

2 files changed

+293
-31
lines changed

‎CONTRIBUTING.md

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
如何为 hackathon.chat 贡献内容
2+
非常感谢您有兴趣为 hackathon.chat 做出贡献！我们是一个开放的、由社区驱动的项目，旨在收录全球各地的黑客马拉松与科技大会信息。您的每一次贡献都非常有价值。
3+
4+
这份指南将引导您轻松地完成一次活动信息的添加。
5+
6+
贡献方式：添加一个 Markdown 文件
7+
我们项目的核心理念是“一个活动 = 一个 Markdown 文件”。您不需要懂复杂的编程知识，只需要按照规定的格式，在指定文件夹中添加一个 .md 文件，就完成了一次贡献。
8+
9+
贡献流程 (通过 GitHub 网页)
10+
这是最简单、最推荐的贡献方式，全程无需在您的电脑上安装任何东西。
11+
12+
Fork 本仓库：
13+
首先，请访问我们的 GitHub 仓库主页，点击页面右上角的 Fork 按钮，将项目完整地复制到您自己的 GitHub 账号下。
14+
15+
进入活动文件夹：
16+
在您刚刚 Fork 好的个人仓库中，导航到以下路径：src/content/events/。
17+
18+
创建新文件：
19+
点击页面右上方的 Add file -> Create new file 按钮。
20+
21+
命名文件：
22+
在顶部“Name your file...”输入框中，为您的文件命名。请遵循 YYYY-活动简称.md 的格式，例如 2025-eth-vietnam.md。
23+
24+
填写活动内容：
25+
将下面的 内容模板 完整地复制并粘贴到文件编辑器中，然后像填空一样，仔细修改里面的活动信息。
26+
27+
提交 Pull Request：
28+
填写完毕后，滚动到页面底部，点击 Commit new file 按钮。接着，页面会引导您创建一个 Pull Request (PR)。请简单描述一下您添加的活动，然后点击 Create pull request。
29+
30+
Markdown 文件规范
31+
为了保证网站能正确地展示信息，请严格遵守以下文件规范。
32+
33+
1. 文件命名
34+
采用 YYYY-活动简称.md 的格式，全部使用小写英文字母和短横线 -。
35+
36+
正确示例: 2025-global-ai-summit-sf.md
37+
38+
错误示例: Global AI Summit.md, 2025_ai_summit.md
39+
40+
2. Frontmatter 内容 (核心！)
41+
这是文件最重要的部分，它定义了活动的所有结构化数据。请在文件的最顶部，用 --- 包裹这些内容。
42+
43+
---
44+
title: "活动的完整官方名称"
45+
startDate: YYYY-MM-DD
46+
endDate: YYYY-MM-DD
47+
organizer: "主办方名称"
48+
location:
49+
city: "城市"
50+
country: "国家"
51+
online: false # 如果是纯线上活动，请改为 true
52+
url: "https://活动官网地址" # 必须是有效的网址
53+
image: "/images/your-image-name.png" # 图片的路径，请参考下方的“图片规范”
54+
tags: ["标签1", "标签2"] # 附加标签，例如 "Gaming", "DeFi" 等
55+
56+
# --- 以下为筛选字段，请务必根据选项填写 ---
57+
featured: false # 是否为精选活动？如果是，改为 true
58+
eventType: ["Web3.0"] # 活动分类(可多选), 可选值: "AI", "Big Data", "Cloud", "Fintech", "Gaming", "IoT", "Web3.0"
59+
region: "Asia" # 所在地区(单选), 可选值: "Americas", "Asia", "Europe", "Other"
60+
category: "Conference" # 活动类型(单选), 可选值: "Conference", "Hackathon", "Meetup", "Workshop", "Expo"
61+
---
62+
字段说明
63+
字段 说明 示例
64+
title 活动的官方全称 "Global AI Conference 2025"
65+
startDate 活动开始日期 2025-10-20
66+
endDate 活动结束日期 2025-10-22
67+
organizer 主办方机构名称 "Future Tech Org"
68+
location 包含城市、国家和是否线上的对象 { city: "San Francisco", country: "USA", online: false }
69+
url 指向活动官网的有效链接 "https://example.com/aiconf"
70+
image 活动的封面图路径 "/images/ai-event.png"
71+
tags 描述活动内容的附加标签 ["Machine Learning", "Data Science"]
72+
featured true 或 false，决定是否出现在精选区 true
73+
eventType 活动所属的主要技术分类 ["AI", "Big Data"]
74+
region 活动举办的地理区域 "Americas"
75+
category 活动的性质 "Conference"
76+
77+
当然有！您现在需要的是一份清晰、友好且详尽的贡献者指南。这份文档是您开源项目的“说明书”，它能极大地降低新参与者的门槛，确保提交的内容格式统一，并展现出您项目的专业性。
78+
79+
通常，在开源项目中，这份指南的名字是 CONTRIBUTING.md。
80+
81+
下面，我为您起草了一份可以直接使用的 CONTRIBUTING.md 文件内容。它结合了您最新的文件结构和 Frontmatter 规范，并采用了对新手最友好的“通过 GitHub 网页提交”的流程。
82+
83+
使用方法
84+
在您的 hackathon 项目根目录下，找到 CONTRIBUTING.md 文件（如果不存在就新建一个）。
85+
86+
将下面的所有内容完整地复制并粘贴到 CONTRIBUTING.md 文件中。
87+
88+
保存文件，然后将它提交并推送到您的 GitHub 仓库。之后，在您的仓库主页，这个文件就会被醒目地展示给所有潜在的贡献者。
89+
90+
(请从下面这行开始复制)
91+
92+
如何为 hackathon.chat 贡献内容
93+
非常感谢您有兴趣为 hackathon.chat 做出贡献！我们是一个开放的、由社区驱动的项目，旨在收录全球各地的黑客马拉松与科技大会信息。您的每一次贡献都非常有价值。
94+
95+
这份指南将引导您轻松地完成一次活动信息的添加。
96+
97+
贡献方式：添加一个 Markdown 文件
98+
我们项目的核心理念是“一个活动 = 一个 Markdown 文件”。您不需要懂复杂的编程知识，只需要按照规定的格式，在指定文件夹中添加一个 .md 文件，就完成了一次贡献。
99+
100+
贡献流程 (通过 GitHub 网页)
101+
这是最简单、最推荐的贡献方式，全程无需在您的电脑上安装任何东西。
102+
103+
Fork 本仓库：
104+
首先，请访问我们的 GitHub 仓库主页，点击页面右上角的 Fork 按钮，将项目完整地复制到您自己的 GitHub 账号下。
105+
106+
进入活动文件夹：
107+
在您刚刚 Fork 好的个人仓库中，导航到以下路径：src/content/events/。
108+
109+
创建新文件：
110+
点击页面右上方的 Add file -> Create new file 按钮。
111+
112+
命名文件：
113+
在顶部“Name your file...”输入框中，为您的文件命名。请遵循 YYYY-活动简称.md 的格式，例如 2025-eth-vietnam.md。
114+
115+
填写活动内容：
116+
将下面的 内容模板 完整地复制并粘贴到文件编辑器中，然后像填空一样，仔细修改里面的活动信息。
117+
118+
提交 Pull Request：
119+
填写完毕后，滚动到页面底部，点击 Commit new file 按钮。接着，页面会引导您创建一个 Pull Request (PR)。请简单描述一下您添加的活动，然后点击 Create pull request。
120+
121+
Markdown 文件规范
122+
为了保证网站能正确地展示信息，请严格遵守以下文件规范。
123+
124+
1. 文件命名
125+
采用 YYYY-活动简称.md 的格式，全部使用小写英文字母和短横线 -。
126+
127+
正确示例: 2025-global-ai-summit-sf.md
128+
129+
错误示例: Global AI Summit.md, 2025_ai_summit.md
130+
131+
2. Frontmatter 内容 (核心！)
132+
这是文件最重要的部分，它定义了活动的所有结构化数据。请在文件的最顶部，用 --- 包裹这些内容。
133+
134+
内容模板
135+
YAML
136+
137+
---
138+
title: "活动的完整官方名称"
139+
startDate: YYYY-MM-DD
140+
endDate: YYYY-MM-DD
141+
organizer: "主办方名称"
142+
location:
143+
city: "城市"
144+
country: "国家"
145+
online: false # 如果是纯线上活动，请改为 true
146+
url: "https://活动官网地址" # 必须是有效的网址
147+
image: "/images/your-image-name.png" # 图片的路径，请参考下方的“图片规范”
148+
tags: ["标签1", "标签2"] # 附加标签，例如 "Gaming", "DeFi" 等
149+
150+
# --- 以下为筛选字段，请务必根据选项填写 ---
151+
featured: false # 是否为精选活动？如果是，改为 true
152+
eventType: ["Web3.0"] # 活动分类(可多选), 可选值: "AI", "Big Data", "Cloud", "Fintech", "Gaming", "IoT", "Web3.0"
153+
region: "Asia" # 所在地区(单选), 可选值: "Americas", "Asia", "Europe", "Other"
154+
category: "Conference" # 活动类型(单选), 可选值: "Conference", "Hackathon", "Meetup", "Workshop", "Expo"
155+
---
156+
字段说明
157+
字段 说明 示例
158+
title 活动的官方全称 "Global AI Conference 2025"
159+
startDate 活动开始日期 2025-10-20
160+
endDate 活动结束日期 2025-10-22
161+
organizer 主办方机构名称 "Future Tech Org"
162+
location 包含城市、国家和是否线上的对象 { city: "San Francisco", country: "USA", online: false }
163+
url 指向活动官网的有效链接 "https://example.com/aiconf"
164+
image 活动的封面图路径 "/images/ai-event.png"
165+
tags 描述活动内容的附加标签 ["Machine Learning", "Data Science"]
166+
featured true 或 false，决定是否出现在精选区 true
167+
eventType 活动所属的主要技术分类 ["AI", "Big Data"]
168+
region 活动举办的地理区域 "Americas"
169+
category 活动的性质 "Conference"
170+
171+
导出到 Google 表格
172+
3. 正文内容
173+
在下方 --- 分隔线之后，您可以使用标准的 Markdown 语法，添加关于活动的详细介绍、日程安排、演讲嘉宾等任何您认为有用的信息。
174+
175+
图片规范
176+
图片尺寸：推荐使用宽高比为 16:9 的图片，例如 800x450 或 400x225 像素，以获得最佳展示效果。
177+
178+
上传位置：请将活动图片上传到项目的 public/images/ 文件夹中。
179+
180+
引用路径：在 .md 文件的 image 字段中，路径请以 /images/ 开头，例如 image: "/images/eth-vietnam.png"。
181+
182+
提交之后
183+
在您提交 Pull Request 后，项目维护者会尽快进行审查。我们可能会提出一些修改建议。一旦您的 PR 被合并，GitHub Actions 会自动将您的贡献部署到 hackathon.chat 网站上。
184+
185+
再次感谢您的宝贵贡献！

‎README.md

Lines changed: 108 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,124 @@
1-
# Astro Starter Kit: Minimal
1+
# Hackathon.chat 🚀
22

3-
```sh
4-
npm create astro@latest -- --template minimal
3+
**Hackathon.chat** is an open-source platform dedicated to collecting and showcasing global tech events, providing developers, entrepreneurs, and tech enthusiasts with a centralized hub for event information.
4+
5+
## 🎯 Mission
6+
7+
- **Global Tech Event Aggregator**: Collect hackathons, tech conferences, innovation summits, and other tech events from around the world
8+
- **Developer-Friendly**: Simplified contribution process that allows community members to easily add events
9+
- **Diverse Coverage**: Covers multiple tech domains including AI, Blockchain, Big Data, Cloud Computing, Fintech, Gaming, IoT, and more
10+
- **Regional Organization**: Events organized by regions (Americas, Asia, Europe, etc.) for easy local discovery
11+
12+
## 🌟 Features
13+
14+
- 📅 Time-sorted event listings
15+
- 🏷️ Multi-dimensional tag classification (tech type, region)
16+
- ⭐ Featured event recommendations
17+
- 🔍 Smart filtering functionality
18+
- 📱 Responsive design with mobile support
19+
20+
## 🤝 How to Contribute Events
21+
22+
### Step 1: Fork the Repository
23+
Click the "Fork" button in the top-right corner to copy the project to your GitHub account.
24+
25+
### Step 2: Create Event File
26+
Create a new `.md` file in the `src/content/events/` directory. Use a descriptive filename based on the event name, e.g., `eth-vietnam-2025.md`
27+
28+
### Step 3: Fill Event Information
29+
Use the following template to fill in event details:
30+
31+
```yaml
32+
---
33+
title: "Event Title"
34+
startDate: 2025-08-09
35+
location:
36+
city: "City Name"
37+
country: "Country Name"
38+
url: "https://event-website-link"
39+
image: "/images/event-image.png"
40+
featured: true
41+
eventType: ["AI", "Web3.0"] # Options: AI, Big Data, Cloud, Fintech, Gaming, IoT, Web3.0
42+
region: "Asia" # Options: Americas, Asia, Europe, Other
43+
---
544
```
645

7-
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal)
8-
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal)
9-
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json)
46+
### Step 4: Add Event Image (Optional)
47+
If you have an event image, place it in the `public/images/` directory. Recommended size: 400×225 pixels.
1048

11-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
49+
### Step 5: Submit Pull Request
50+
1. Commit your changes to your forked repository
51+
2. Create a Pull Request to the main repository
52+
3. Wait for review and merge
1253

13-
## 🚀 Project Structure
54+
## 📋 Field Reference
1455

15-
Inside of your Astro project, you'll see the following folders and files:
56+
| Field | Type | Required | Description |
57+
|-------|------|----------|-------------|
58+
| `title` | String | ✅ | Event title |
59+
| `startDate` | Date | ✅ | Start date (YYYY-MM-DD) |
60+
| `location.city` | String | ✅ | Host city |
61+
| `location.country` | String | ✅ | Host country |
62+
| `url` | String | ✅ | Official event website |
63+
| `image` | String | ✅ | Event image path |
64+
| `featured` | Boolean | ✅ | Whether it's a featured event |
65+
| `eventType` | Array | ✅ | Event type tags |
66+
| `region` | String | ✅ | Geographic region |
1667

17-
```text
18-
/
19-
├── public/
20-
├── src/
21-
│ └── pages/
22-
│ └── index.astro
23-
└── package.json
68+
### eventType Options
69+
- `AI` - Artificial Intelligence
70+
- `Big Data` - Big Data & Analytics
71+
- `Cloud` - Cloud Computing
72+
- `Fintech` - Financial Technology
73+
- `Gaming` - Gaming & Entertainment
74+
- `IoT` - Internet of Things
75+
- `Web3.0` - Web3.0 & Blockchain
76+
77+
### region Options
78+
- `Americas` - North & South America
79+
- `Asia` - Asia & Pacific
80+
- `Europe` - Europe & Africa
81+
- `Other` - Other regions
82+
83+
## 🛠️ Local Development
84+
85+
```bash
86+
# Install dependencies
87+
npm install
88+
89+
# Start development server
90+
npm run dev
91+
92+
# Build for production
93+
npm run build
94+
95+
# Preview production build
96+
npm run preview
2497
```
2598

26-
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
99+
## 📝 Contribution Guidelines
100+
101+
1. Ensure event information is accurate and up-to-date
102+
2. Use clear and descriptive event titles
103+
3. Provide valid official website links
104+
4. Select appropriate event types and region tags
105+
5. If including images, ensure good quality and proper dimensions
106+
107+
## 🤖 Tech Stack
27108

28-
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
109+
- **Framework**: [Astro](https://astro.build/)
110+
- **Styling**: CSS
111+
- **Deployment**: GitHub Pages
112+
- **Content Management**: Markdown + Frontmatter
29113

30-
Any static assets, like images, can be placed in the `public/` directory.
114+
## 📄 License
31115

32-
## 🧞 Commands
116+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
33117

34-
All commands are run from the root of the project, from a terminal:
118+
## 🙏 Acknowledgments
35119

36-
| Command | Action |
37-
| :------------------------ | :----------------------------------------------- |
38-
| `npm install` | Installs dependencies |
39-
| `npm run dev` | Starts local dev server at `localhost:4321` |
40-
| `npm run build` | Build your production site to `./dist/` |
41-
| `npm run preview` | Preview your build locally, before deploying |
42-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
43-
| `npm run astro -- --help` | Get help using the Astro CLI |
120+
Thanks to all developers and community members who contribute event information to Hackathon.chat!
44121

45-
## 👀 Want to learn more?
122+
---
46123

47-
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
124+
**Let's build the world's most comprehensive tech event platform together!** 🌍✨

0 commit comments

Comments
 (0)