Compare commits
No commits in common. "3a37c3fd58c77dbd51b70e8a04c97d07fd1f9d0a" and "aadccafcf2acbea8037e41218c516b71db870d1e" have entirely different histories.
3a37c3fd58
...
aadccafcf2
1 changed files with 9 additions and 17 deletions
26
README.md
26
README.md
|
@ -1,45 +1,37 @@
|
||||||
**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.
|
|
Loading…
Add table
Reference in a new issue