Skip to content

A little nextjs app which can send reminders to telegram.

Notifications You must be signed in to change notification settings

aromko/remember-me-service

Repository files navigation

[RMS] Remember me service (DEPRECATED)

All Contributors build next-version mongodb-version codecov

Bildschirmfoto 2024-01-14 um 14 47 01

The remind me service, RMS for short, contains a small web application that allows you to manage reminders. These reminders are sent via push messages to Telegram (in the future, other interfaces will also be connected).

What can you use the RMS for?

Let your imagination run wild 😏

You can install the RMS e.g. on a server in your home network. Each user can then create reminders. These are then sent on the execution date by push message to your phone. Great or?

Technologies

Next.js MongoDB

The RMS uses the React framework next.js. The NoSQL-MongoDB is used as database.

Prerequisites

1. Create your telegram bot

In order to use the RMS with all his features you need to create a telegram bot. To create this bot follow the following guide BotFather.

2. Create your mongoDB

After creating your mongoDB database click under Deployment -> Database Connect -> Connect your application and copy the connection string.

Note:

  • use the shared Cluster to have a free mongoDB
  • don't forgot to replace the password and add your database name
    mongodb+srv://admin:< password >@cluster0.6xnyv.mongodb.net/< databaseName >?retryWrites=true&w=majority

3. .env.local

Create an .env.local in your folder and add the following variables:

  • NEXT_PUBLIC_TELEGRAM_BOT_TOKEN=< add the generated token from BotFather >

  • MONGODB_URI=< add the customized mongoDB uri>

How to run locally?

pnpm install
pnpm run dev

Open the browser under localhost:3000

How to run in productive environment?

pnpm run build (build the application for production usage)
pnpm run start (start a Next.js production server)

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Marcel Köhler
Marcel Köhler

💻 🎨 📖 🚧
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!

About

A little nextjs app which can send reminders to telegram.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published