System-End/YSWS-Catalog
1
0
Fork 0
mirror of https://github.com/System-End/YSWS-Catalog.git synced 2026-04-19 14:27:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix: document api in README and create .gitignore

Browse source
This commit is contained in:
joshpinto6 2025-05-29 11:51:01 +00:00
parent 712dc28516
commit a66a082697
2 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
node_modules
package-lock.json

3
README.md
View file

@ -13,6 +13,7 @@
- **Real-time Deadline Updates:** Deadlines are updated in real-time to reflect the current status, ensuring information is always up-to-date.
- **Responsive Design:** Optimized for various screen sizes and devices, providing a seamless experience on desktops, tablets, and mobile devices.
- **RSS Feed:** Subscribe to get notifications about active YSWS programs in your favorite RSS reader.
- **JSON API:** Get full data as a json object
## Getting Started
@ -55,6 +56,8 @@ This feed is automatically updated whenever new programs are added or existing p
- Handling theme toggling
- Managing program detail modals
- Updating deadlines in real-time
- **generate-json.js:** Generates a JSON file equivalent of the data.yml (for API use)
- **generate-rss.js:** Generates an RSS feed.xml file
## Data Source & Example