github/MIND
1
1
Fork 0
mirror of https://github.com/Casvt/MIND.git synced 2026-04-03 03:00:22 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation page

Browse Source
This commit is contained in:
CasVT
2023-06-21 00:19:49 +02:00
parent 97bde5dc07
commit 47e5854f42
11 changed files with 409 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@@ -1,30 +1,28 @@
# MIND Reminders
A simple self hosted reminder platform that uses push to send notifications to your device. Set the reminder and forget about it! 📢
# MIND
[![Docker Pulls](https://img.shields.io/docker/pulls/mrcas/mind.svg)](https://hub.docker.com/r/mrcas/mind)
[![GitHub Downloads](https://img.shields.io/github/downloads/Casvt/MIND/total.svg)](https://github.com/Casvt/MIND/releases)
__A simple self hosted reminder application that can send push notifications to your device. Set the reminder and forget about it!__
Mind 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
![mind-reminders-home](https://user-images.githubusercontent.com/57927413/213593220-495aeb86-2bf8-4c43-895d-c7cba38c3cee.png)
## Workings
MIND can be used for sending notifications at the desired time. This can be a set time, like a yearly reminder for a birthday, or at a button click, to easily send a predefined notification when you want to.
![mind-reminders-add-notification-services](https://user-images.githubusercontent.com/57927413/212755314-1104531e-7feb-4e59-af1d-927576e47152.png)
## Features
- Works cross-timezone
- Notifications are sent with second-precision
- Uses the [apprise library](https://github.com/caronc/apprise), giving you 80+ platforms to send notifications to
- Easily manage the reminders with sorting options, search ability and color coding
- Docker image available
- Mobile friendly web-interface
- API available
![mind-reminders-edit](https://user-images.githubusercontent.com/57927413/213594471-ecc99a72-cf0f-4570-8e78-92ffbf37e59d.png)
### Planned Features
You can see the planned features in the [Project board](https://github.com/users/Casvt/projects/3).
![mind-reminders-settings](https://user-images.githubusercontent.com/57927413/212755327-b45da53c-72f7-480c-9a77-eaad28803fbb.png)
## Core Features
* Basic auth
* Utilizes Apprise
* Create, edit and delete reminders
* Schedule reminders
* Recurring reminders
* Docker image
* Mobile friendly
## Planned Features
You can see our planned features in our [Project board](https://github.com/users/Casvt/projects/3).
## Installation
## Getting started
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 \
@@ -34,13 +32,9 @@ docker run -d \
-p 8080:8080 \
mrcas/mind: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)
![mind-reminders-notification-service](https://user-images.githubusercontent.com/57927413/213593832-6c62307c-cf7c-4d11-b6ce-dea33676d477.png)
More information about installing can be found [in the wiki](https://casvt.github.io/MIND/).
- Click the home icon and create a reminder!
You can see the [wiki](https://github.com/Casvt/MIND/wiki) for instructions on how to install MIND on other OS'es.
## Contact
- For support, a [discord server](https://discord.gg/nMNdgG7vsE) is available
- Alternatively, [make an issue](https://github.com/Casvt/MIND/issues)