Code Monkey home page Code Monkey logo

birthday-reminder-bot's Introduction

welcome to Birthday Remider Bot ๐Ÿ‘‹

Version Maintenance Licence

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.

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])

๐Ÿš€ 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!


birthday-reminder-bot's People

Contributors

alok722 avatar

Stargazers

 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.