mirror of
https://github.com/Casvt/MIND.git
synced 2026-04-03 03:00:22 -04:00
d1d39a94ff
* Update README.md * Update README.md * Fixed problem with docker volume mount location * Updated docker compose with new volume mount location * Fixed folder creation for db file * Added support for cross-timezone clients * Fixed database test Co-authored-by: Noted <57927413+ItsNoted@users.noreply.github.com>
47 lines
1.9 KiB
Markdown
47 lines
1.9 KiB
Markdown
# Noted Reminders
|
|
A simple self hosted reminder platform that uses push to send notifications to your device. Set the reminder and forget about it! 📢
|
|
|
|
Noted is a simple self hosted application for creating reminders that get pushed to your device using the [Apprise](https://github.com/caronc/apprise) API. You can send messages to just about every platform, including scheduled emails!
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Core Features
|
|
* Basic auth
|
|
* Utilizes Apprise
|
|
* Create, edit and delete reminders
|
|
* Schedule reminders
|
|
* Recurring reminders
|
|
* Docker image
|
|
* Mobile fiendly
|
|
|
|
## Planned Features
|
|
You can see our planned features in our [Project board](https://github.com/users/Casvt/projects/3).
|
|
|
|
## Installation
|
|
Replace the timezone value (`TZ=`) to the [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of your timezone!
|
|
```bash
|
|
docker run -d \
|
|
--name noted \
|
|
-v noted-db:/app/db \
|
|
-e TZ=Europe/Amsterdam \
|
|
-p 8080:8080 \
|
|
mrcas/noted:latest
|
|
```
|
|
## Getting Started
|
|
- Create a new account
|
|
- Click the bell icon on the left side to add an Apprise push option and save it (Here is an example using Pushover)
|
|
|
|
|
|
|
|
|
|
- Click the home icon and create a reminder!
|
|
|
|
You can see the [wiki](https://github.com/Casvt/Noted/wiki) for instructions on how to install Noted on other OS'es.
|