The Cloud Reminder App is a โ ๏ธ cloud-based application that allows you to create reminders and automatically sends SMS ๐ฑ and email ๐ง notifications at the specified time. It utilizes Firebase Functions, Twilio for SMS functionality, and Nodemailer for email functionality.
- Create reminders with a message, phone number, email, and reminder time. โฐ
- Reminders are stored in Firestore for persistence. ๐พ
- Automatic SMS reminders sent using Twilio. ๐ฒ
- Automatic email reminders sent using Nodemailer. โ๏ธ
- Scheduled reminders based on the specified reminder time. ๐
Before running the Cloud Reminder App, ensure you have the following prerequisites:
- A Firebase project set up. ๐ฅ
- Node.js and npm (Node Package Manager) installed on your machine. ๐
To get started with the Cloud Reminder App, follow these steps:
- Clone the repository:
git clone https://github.com/ighoshsubho/Cloud-Reminder.git
๐ฅ - Navigate to the project directory: cd reminder-app ๐
- Install the dependencies: npm install โ๏ธ
Before running the Cloud Reminder App, make sure to configure the following:
- Firebase project: Set up your Firebase project and obtain the necessary configuration credentials. Update the Firebase configuration in the Firebase initialization code. ๐
- Twilio: Sign up for a Twilio account and obtain your Twilio SID and token. Update the Twilio client initialization with your Twilio credentials. ๐
- Nodemailer: Create a Gmail account to use as the sender for email reminders. Update the transporter configuration with your Gmail account details. ๐ง
The Cloud Reminder App consists of two main components: creating a reminder and sending reminders.
To create a reminder, make an HTTP POST request to the /createReminder
endpoint with the following parameters:
message
: The reminder message. ๐ฌphoneNumber
: The phone number to receive SMS reminders. ๐ฑemail
: The email address to receive email reminders. ๐งreminderTime
: The time at which the reminder should be sent (formatted as ISO string). โฐ
The Cloud Reminder App automatically sends reminders at the specified time using Firebase's Pub/Sub scheduler.
- SMS Reminders: The sendReminderSMS function sends SMS reminders. It runs every minute and sends SMS messages using Twilio. ๐ฒ
- Email Reminders: The sendReminderEmail function sends email reminders. It runs every minute and sends email notifications using Nodemailer. โ๏ธ
Contributions to the Cloud Reminder App are welcome! If you encounter any issues or have suggestions for improvements, please submit a pull request or open an issue on the GitHub repository. ๐
The Cloud Reminder App is licensed under the MIT License. ๐