You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-6Lines changed: 14 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,6 @@
2
2
3
3
**YSWS-Catalog** is a web-based directory showcasing Hack Club’s "You Ship, We Ship" (YSWS) programs. Each YSWS program rewards participants for building and shipping projects—hardware, software, art, and more—by sending them physical or digital goodies. This repository hosts the source code for the catalog, allowing anyone to explore, filter, and learn about these initiatives. If you want to add or update a program, feel free to submit a pull request!
4
4
5
-
> **Note:**
6
-
The actively maintained version of this project is now hosted at [hackclub/YSWS-Catalog](https://github.com/hackclub/YSWS-Catalog). This repository is the original version created by me and is not updated by the community. Please refer to the maintained repository.
7
-
8
5
## Features
9
6
10
7
-**Dynamic Program Listing:** All YSWS programs are defined in `script.js` for easy editing.
@@ -15,12 +12,14 @@ The actively maintained version of this project is now hosted at [hackclub/YSWS-
15
12
-**Deadline Indicators:** Visual indicators for program deadlines, highlighting urgent and very urgent statuses to help prioritize participation.
16
13
-**Real-time Deadline Updates:** Deadlines are updated in real-time to reflect the current status, ensuring information is always up-to-date.
17
14
-**Responsive Design:** Optimized for various screen sizes and devices, providing a seamless experience on desktops, tablets, and mobile devices.
15
+
-**RSS Feed:** Subscribe to get notifications about active YSWS programs in your favorite RSS reader.
This feed is automatically updated whenever new programs are added or existing programs' statuses change. You can use this feed with any RSS reader like Feedly, Inoreader, or apps like Glance to get notified about new opportunities.
46
+
40
47
## Project Structure
41
48
42
49
-**index.html:** The main HTML file containing the container for program cards and the modal structure.
@@ -49,6 +56,8 @@ The actively maintained version of this project is now hosted at [hackclub/YSWS-
49
56
- Handling theme toggling
50
57
- Managing program detail modals
51
58
- Updating deadlines in real-time
59
+
-**generate-json.js:** Generates a JSON file equivalent of the data.yml (for API use)
60
+
-**generate-rss.js:** Generates an RSS feed.xml file
52
61
53
62
## Data Source & Example
54
63
@@ -59,7 +68,7 @@ Each program object can include:
59
68
-**Required Fields:**
60
69
-`name`: Program name
61
70
-`description`: Short description of the program
62
-
-`status`: `active`, `upcoming`, or `completed`
71
+
-`status`: `active`, `draft`, or `ended`
63
72
64
73
-**Optional Fields:**
65
74
-`website`: URL or `null`
@@ -115,4 +124,3 @@ details:
115
124
```
116
125
5.**Open a Pull Request:**
117
126
On GitHub, open a PR from your fork to this repository and provide a description of your changes.
0 commit comments