Skip to content

larsmikki/remindr

Repository files navigation

Remindr

screenshot

License: MIT Docker Hub ghcr.io Node 20

Remindr is a self-hosted reminder app. Track birthdays, anniversaries, appointments, trips, deadlines — any date worth remembering — with tags, icons, and a countdown for each. No database, no cloud, no accounts required.

Features

  • Add reminders with name, date, icon, and notes
  • Tags — organize reminders into custom categories
  • Search and filter your list
  • Countdown to the next occurrence of each date
  • Export and import backups as JSON
  • 10+ built-in themes (light and dark)
  • No database — all data stored in a single JSON file
  • No tracking, no accounts, no cloud

Getting started

Pick whichever install path matches your setup. All paths land on http://localhost:3080.

1. Docker (Docker Desktop, NAS, or any Docker server)

Works on Synology, Unraid, TrueNAS, QNAP, Proxmox, or a plain Docker host.

docker run -d \
  --name remindr \
  -p 3080:3080 \
  -v remindr-data:/app/data \
  --restart unless-stopped \
  larsmikki/remindr:latest

Or with Compose:

services:
  remindr:
    image: larsmikki/remindr:latest
    container_name: remindr
    ports:
      - "3080:3080"
    volumes:
      - remindr-data:/app/data
    restart: unless-stopped

volumes:
  remindr-data:

2. Local install on Windows

Requires Git for Windows and Node.js 20+.

git clone https://github.com/larsmikki/remindr.git
cd remindr
npm install
npm run dev      # Vite client on :3080
# In a second terminal:
npm run server   # API on :3081

For a production build: npm run build && npm start.

3. Local install on macOS

brew install node git
git clone https://github.com/larsmikki/remindr.git
cd remindr
npm install
npm run dev      # in one terminal
npm run server   # in another

For a production build: npm run build && npm start.

4. Local install on Linux

Debian/Ubuntu:

curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get install -y nodejs git

git clone https://github.com/larsmikki/remindr.git
cd remindr
npm install
npm run dev      # in one terminal
npm run server   # in another

On Fedora/RHEL use dnf install nodejs git; on Arch use pacman -S nodejs npm git.

For a production build: npm run build && npm start.

Configuration

Variable Default Description
PORT 3080 Port the server listens on
REMINDERS_FILE /app/data/reminders.json Path to the data file

Usage

Action How
Add a reminder Click Add Reminder
Edit Click the pencil icon on any card
Add tags Settings → Tags
Filter by tag Click a tag badge on the main page
Export backup Settings → Export
Import backup Settings → Import
Change theme Settings → Themes

Data

All data is stored in a single file in the Docker volume:

/app/data/
  reminders.json    # all reminders and tags

License

MIT

Support

If Remindr saves you time, consider buying me a coffee or donating via PayPal. It helps keep the project free and maintained.

About

Self-hosted reminder app for birthdays, anniversaries, appointments, deadlines — any date worth remembering. No database, no cloud, runs in a single Docker container.

Topics

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors