ryanmwangi
/
CalMerger
1
0
Fork 1
Code Issues 2 Pull Requests Releases Activity

Update README.md

This commit is contained in:
Ryan Mwangi 2024-10-10 02:35:05 +03:00 committed by GitHub
parent aadccafcf2
commit 8124ed040a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,37 +1,44 @@
Calendar Merger Project **Calendar Merger Project**
Overview **Overview **
The Calendar Merger project is a web application that allows users to merge multiple calendars into a single calendar. The application provides a simple and intuitive interface for users to add calendars, specify prefixes for each calendar, and override the event summaries if desired. The Calendar Merger project is a web application that allows users to merge multiple calendars into a single calendar. The application provides a simple and intuitive interface for users to add calendars, specify prefixes for each calendar, and override the event summaries if desired.
Features **Features**
Merge multiple calendars into a single calendar Merge multiple calendars into a single calendar
Specify prefixes for each calendar Specify prefixes for each calendar
Override event summaries if desired Override event summaries if desired
Generate a unique URL for the merged calendar Generate a unique URL for the merged calendar
Update the merged calendar every hour using a cron job Update the merged calendar every hour using a cron job
Requirements **Requirements**
Node.js (version 14 or higher) Node.js (version 14 or higher)
Express.js (version 4 or higher) Express.js (version 4 or higher)
ical (version 0.7 or higher) ical (version 0.7 or higher)
axios (version 0.21 or higher) axios (version 0.21 or higher)
cron (version 1.8 or higher) cron (version 1.8 or higher)
Installation **Installation**
Clone the repository Clone the repository
Install the dependencies using npm install Install the dependencies using npm install
Start the server using npm start Start the server using npm start
Usage **Usage**
Open a web browser and navigate to http://localhost:3000 Open a web browser and navigate to http://localhost:3000
Click on the "Add Calendar" button to add a new calendar Click on the "Add Calendar" button to add a new calendar
Enter the calendar URL, prefix, and override options as desired Enter the calendar URL, prefix, and override options as desired
Click on the "Merge Calendars" button to generate the merged calendar Click on the "Merge Calendars" button to generate the merged calendar
The merged calendar URL will be displayed on the page The merged calendar URL will be displayed on the page
API Endpoints **API Endpoints**
GET /: Returns the index.html file GET /: Returns the index.html file
POST /merge: Merges the calendars and returns the merged calendar URL POST /merge: Merges the calendars and returns the merged calendar URL
GET /:filename: Returns the merged calendar file GET /:filename: Returns the merged calendar file
Contributing **Contributing**
Contributions are welcome! If you'd like to contribute to the project, please fork the repository and submit a pull request. Contributions are welcome! If you'd like to contribute to the project, please fork the repository and submit a pull request.