CalMerger/README.md

**Calendar Merger Project**

**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.

**Features**

Merge multiple calendars into a single calendar
Specify prefixes for each calendar
Override event summaries if desired
Generate a unique URL for the merged calendar
Update the merged calendar every hour using a cron job

**Requirements**

Node.js (version 14 or higher)
Express.js (version 4 or higher)
ical (version 0.7 or higher)
axios (version 0.21 or higher)
cron (version 1.8 or higher)

**Installation**

Clone the repository
Install the dependencies using npm install
Start the server using npm start

**Key Terms**

Calendar Feed: This typically refers to a data format that allows users to subscribe to calendar events. It can be in formats like iCalendar (.ics) or other web-based formats.

Webcal: This is a URL scheme that allows users to subscribe to calendar feeds. It is often used in conjunction with iCalendar files and is recognized by many calendar applications.

CalDAV: This is an Internet standard that allows clients to access and manage calendar data on a remote server. It is often used for syncing calendars across different devices and platforms.

Prefix: In this context, a prefix might refer to a string that is added to the beginning of a calendar feed URL or identifier. It can help in organizing or categorizing different calendar feeds.

Merged Feed: This refers to a single calendar feed that combines multiple calendar sources into one. It allows users to view events from different calendars in a unified manner.

**Usage**

Open a web browser and navigate to http://localhost:3000
Click on the "Add Calendar" button to add a new calendar
Enter the calendar URL, prefix, and override options as desired
Click on the "Merge Calendars" button to generate the merged calendar
The merged calendar URL will be displayed on the page

**API Endpoints**

GET /: Returns the index.html file
POST /merge: Merges the calendars and returns the merged calendar URL
GET /:filename: Returns the merged calendar file

**Contributing**

Contributions are welcome! If you'd like to contribute to the project, please fork the repository and submit a pull request.
Update README.md 2024-10-09 23:35:05 +00:00			`Calendar Merger Project`
Update README.md 2024-10-09 23:35:22 +00:00
Update README.md 2024-10-09 23:35:43 +00:00			`Overview`
Update README.md 2024-10-09 23:35:05 +00:00
edit README 2024-10-09 23:32:42 +00:00			`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.`

Update README.md 2024-10-09 23:35:05 +00:00			`Features`

edit README 2024-10-09 23:32:42 +00:00			`Merge multiple calendars into a single calendar`
			`Specify prefixes for each calendar`
			`Override event summaries if desired`
			`Generate a unique URL for the merged calendar`
			`Update the merged calendar every hour using a cron job`

Update README.md 2024-10-09 23:35:05 +00:00			`Requirements`

edit README 2024-10-09 23:32:42 +00:00			`Node.js (version 14 or higher)`
			`Express.js (version 4 or higher)`
			`ical (version 0.7 or higher)`
			`axios (version 0.21 or higher)`
			`cron (version 1.8 or higher)`

Update README.md 2024-10-09 23:35:05 +00:00			`Installation`

edit README 2024-10-09 23:32:42 +00:00			`Clone the repository`
			`Install the dependencies using npm install`
			`Start the server using npm start`

add key terms to readme 2024-10-16 16:08:43 +00:00			`Key Terms`

			`Calendar Feed: This typically refers to a data format that allows users to subscribe to calendar events. It can be in formats like iCalendar (.ics) or other web-based formats.`

			`Webcal: This is a URL scheme that allows users to subscribe to calendar feeds. It is often used in conjunction with iCalendar files and is recognized by many calendar applications.`

			`CalDAV: This is an Internet standard that allows clients to access and manage calendar data on a remote server. It is often used for syncing calendars across different devices and platforms.`

			`Prefix: In this context, a prefix might refer to a string that is added to the beginning of a calendar feed URL or identifier. It can help in organizing or categorizing different calendar feeds.`

			`Merged Feed: This refers to a single calendar feed that combines multiple calendar sources into one. It allows users to view events from different calendars in a unified manner.`

Update README.md 2024-10-09 23:35:05 +00:00			`Usage`

edit README 2024-10-09 23:32:42 +00:00			`Open a web browser and navigate to http://localhost:3000`
			`Click on the "Add Calendar" button to add a new calendar`
			`Enter the calendar URL, prefix, and override options as desired`
			`Click on the "Merge Calendars" button to generate the merged calendar`
			`The merged calendar URL will be displayed on the page`

Update README.md 2024-10-09 23:35:05 +00:00			`API Endpoints`

edit README 2024-10-09 23:32:42 +00:00			`GET /: Returns the index.html file`
			`POST /merge: Merges the calendars and returns the merged calendar URL`
			`GET /:filename: Returns the merged calendar file`

Update README.md 2024-10-09 23:35:05 +00:00			`Contributing`

			`Contributions are welcome! If you'd like to contribute to the project, please fork the repository and submit a pull request.`