Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itsfelixh/birthday-calendar-sync
Automates birthday management by fetching contacts from Google Contacts, creating and updating birthday events in Google Calendar, customizable
https://github.com/itsfelixh/birthday-calendar-sync
birthday birthday-calendar birthday-reminder birthday-sync clasp google-apps-script google-calendar google-contacts javascript js
Last synced: 20 days ago
JSON representation
Automates birthday management by fetching contacts from Google Contacts, creating and updating birthday events in Google Calendar, customizable
- Host: GitHub
- URL: https://github.com/itsfelixh/birthday-calendar-sync
- Owner: itsFelixH
- Created: 2024-12-10T17:57:27.000Z (29 days ago)
- Default Branch: main
- Last Pushed: 2024-12-14T16:24:29.000Z (25 days ago)
- Last Synced: 2024-12-14T17:24:37.856Z (25 days ago)
- Topics: birthday, birthday-calendar, birthday-reminder, birthday-sync, clasp, google-apps-script, google-calendar, google-contacts, javascript, js
- Language: JavaScript
- Homepage:
- Size: 71.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Birthday Calendar Sync
This project synchronizes birthdays from Google Contacts to a designated Google Calendar. It utilizes Google Apps Script and the `clasp` command-line interface for local development and deployment.
## Project Structure
project_root/
├── src/
│ ├── birthday_contact.gs
│ ├── config.gs
│ ├── main.gs
│ ├── utils.gs
├── .clasp.json
├── appsscript.json
└── README.md
- **`config.gs`**: Contains configurations and constants.
- **`birthday_contact.gs`**: Definition of the `BirthdayContact` class.
- **`main.gs`**: Main functions for synchronizing and updating birthdays.
- **`utils.gs`**: Utility functions used for various tasks such as fetching contacts and deleting events.
## Prerequisites
- [Node.js](https://nodejs.org/): Download and install Node.js from [Node.js Website](https://nodejs.org/)
- [clasp](https://github.com/google/clasp): Install the clasp command-line interface globally using npm:
```bash
npm install -g @google/clasp
```
## Setup
### 1. Authentication with clasp
Ensure you have Node.js installed. Login to clasp using your Google account:
```bash
clasp login
```
### 2. Create a Google Apps Script Project
```bash
clasp create --type standalone --title "Birthday Calendar Sync"
```
### 3. Clone the Project Repository
Clone your Git repository containing the project files to your local machine:
```bash
git clone https://github.com/itsFelixH/birthday-calendar-sync.git
cd birthday-calendar-sync
```
### 4. Link Your Project with Google Apps Script
Make sure the `scriptId` in the `.clasp.json` file matches your Google Apps Script project. You can find the `scriptId` in the URL of your newly created Google Apps Script project.
### 5. Configure the Project
Open `src/config.gs` and customize the configuration settings:
```js
// Calendar ID for Birthday Events
var calendarId = "[email protected]";
// Optional Label Filter for Birthdays
var useLabel = false;
var labels = ["Label 1", "Label 2"];
// Reminder Settings
var addReminder = "popup"; // Reminder type (popup, email, sms)
var reminderInMinutes = 60 * 12; // Reminder notification time (12 hours)
// Birthday Summaries Creation
var createSummaries = true;
// Year for Events (defaults to current year)
var yearToUse = new Date().getFullYear();
// String to identify delete events (optional)
var deleteString = "xxxxxxxxxxxxxxxxxxx";
// Date range for deleting events (optional)
var deleteStartDate = new Date("2023-01-01");
var deleteEndDate = new Date("2025-12-31");
```
### 7. Push the Code to Google Apps Script
Deploy your local code to your Google Apps Script project:
```bash
clasp push
```
This will upload all files to your Google Apps Script project.
## Usage
You can call these functions from the Script Editor in Google Apps Script:
- `updateBirthdaysAndSummariesInCalendar()`: Updates birthdays and summaries in the calendar based on the configurations.
- `deleteEvents()`: Deletes events from the calendar based on the specified criteria.