https://github.com/alok722/birthday-reminder-bot
an express server bot that will remind me to wish Birthdays to my friends.
https://github.com/alok722/birthday-reminder-bot
birthday-reminder bot mongodb node-bot nodejs
Last synced: 14 days ago
JSON representation
an express server bot that will remind me to wish Birthdays to my friends.
- Host: GitHub
- URL: https://github.com/alok722/birthday-reminder-bot
- Owner: alok722
- License: mit
- Created: 2021-07-20T06:49:08.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-06-12T16:16:56.000Z (almost 3 years ago)
- Last Synced: 2025-05-06T22:57:30.273Z (14 days ago)
- Topics: birthday-reminder, bot, mongodb, node-bot, nodejs
- Language: JavaScript
- Homepage:
- Size: 73.2 KB
- Stars: 2
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
welcome to Birthday Remider Bot 👋
> an express server bot which will remind me to wish Birthday to my friends.
## ❓ But How?
> It runs a cron job daily at 11pm and fetch all the records from MongoDB and check if someone's birthday is tomorrow, if **Yes** it will trigger an email to me reminding me about the Birthday.
## ❔ How can you make this bot work for you?
Follow below steps to make this bot yours.
```sh
Step 1 : Fork this Repository.
Step 2 : Clone the forked repository to your local
Step 3 : Create a .env file in the root and add these keys & value. *
EMAIL:BOT_EMAIL**
PASSWORD:BOT_EMAIL_PASSWORD**
MONGODB_CONNECTION_URL:YOUR_DB_URL
Step 4: Go this path (src\services\notification.service.js) and update line no. 15 & 17
Step 5: Commit and push your changes to github, then host your server.
Step 6: You can add data to MongoDB from postman by running a local instance of this server connected to cloud database. The request url is POST `localhost:3030\api\add` and request body would be, { "name" : "Your Friend Name", "dob" : "2/7"}. Over here the DOB is 2nd July.
* Use Github Secret to set your .env content
** To configure your gmail to send out email on behalf of Bot, please follow this link. https://edigleyssonsilva.medium.com/how-to-send-emails-securely-using-gmail-and-nodejs-eef757525324
```
happy wishing 😊
## 👤 author
**Alok raj ([email protected])**
* website: https://alokraj.tech/
* github: [@alok722](https://github.com/alok722)
* linkedin: [@alok722](https://linkedin.com/in/alok722)
## 🚀 future scope
* making it more generic and easy to use
## 🤝 contributing
contributions, issues and feature requests are welcome!
feel free to check issues page.
## 🙌 show your support
give a ⭐️ if this project helped you!
***