Giter VIP home page Giter VIP logo

cloud-reminder's Introduction

Cloud Reminder App ๐Ÿ‘‹๐Ÿ“…

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.

Features โœจ

  1. Create reminders with a message, phone number, email, and reminder time. โฐ
  2. Reminders are stored in Firestore for persistence. ๐Ÿ’พ
  3. Automatic SMS reminders sent using Twilio. ๐Ÿ“ฒ
  4. Automatic email reminders sent using Nodemailer. โœ‰๏ธ
  5. Scheduled reminders based on the specified reminder time. ๐Ÿ“†

Prerequisites ๐Ÿ“‹

Before running the Cloud Reminder App, ensure you have the following prerequisites:

  1. A Firebase project set up. ๐Ÿ”ฅ
  2. Node.js and npm (Node Package Manager) installed on your machine. ๐Ÿš€

Installation ๐Ÿ› ๏ธ

To get started with the Cloud Reminder App, follow these steps:

  1. Clone the repository: git clone https://github.com/ighoshsubho/Cloud-Reminder.git ๐Ÿ“ฅ
  2. Navigate to the project directory: cd reminder-app ๐Ÿ“‚
  3. Install the dependencies: npm install โš™๏ธ

Configuration โš™๏ธ

Before running the Cloud Reminder App, make sure to configure the following:

  1. Firebase project: Set up your Firebase project and obtain the necessary configuration credentials. Update the Firebase configuration in the Firebase initialization code. ๐Ÿ”‘
  2. Twilio: Sign up for a Twilio account and obtain your Twilio SID and token. Update the Twilio client initialization with your Twilio credentials. ๐Ÿ“ž
  3. Nodemailer: Create a Gmail account to use as the sender for email reminders. Update the transporter configuration with your Gmail account details. ๐Ÿ“ง

Usage ๐Ÿš€

The Cloud Reminder App consists of two main components: creating a reminder and sending reminders.

Creating a Reminder ๐Ÿ“

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). โฐ

Sending Reminders ๐Ÿ“ค

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. โœ‰๏ธ

Contributing ๐Ÿค

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. ๐ŸŽ‰

License ๐Ÿ“„

The Cloud Reminder App is licensed under the MIT License. ๐Ÿ“

cloud-reminder's People

Contributors

ighoshsubho avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.