1 unstable release
| 0.1.0 | Jun 16, 2020 |
|---|
#10 in #basis
2KB
🐻 Remembear
Self-hosted web app for recurring reminders
Remembear was created to manage household chores but can be used for medication reminders, appointment notifications, and anything else occuring on a regular weekly or daily basis!
Installation
Remembear is still under active development but will be available as a binary and Docker container once released. Until then, you can check out the contributor guidelines for steps to build and run remembear locally
Configuration
Remembear is configured by remembear.yml in the directory it's run from. A default configuration file is provided by this repo
Integrations
Integrations can be configured by defining them in an integrations section in remembear.yml. To use an integration, enabled must be set to true:
integrations:
console:
enabled: true
Usage
CLI Usage
| Subcommand | Description | Usage |
|---|---|---|
| Start | Starts the scheduler, running until the process is killed | remembear start |
| Integration | Provides a per-integration CLI interface | remembear integration <integration> [subcommand..] |
Users
| Subcommand | Description | Usage |
|---|---|---|
| Add | Adds a new user | remembear user add <name> |
| List | Lists all users as a JSON array | remembear user list |
| Update | Updates an existing user | remembear user update <uid> [-n name] |
| Remove | Removes a user by their uid | remembear user remove <uid> |
Reminders
| Subcommand | Description | Usage |
|---|---|---|
| Add | Adds a new reminder | remembear reminder add <name> <schedule> [assignees..] |
| List | Lists all reminders as a JSON array | remembear reminder list |
| Update | Updates an existing reminder | remembear reminder update <uid> [-n|--name name] [-s|--schedule schedule] [-a|--assignees assignees..] |
| Remove | Removes a reminder by its uid | remembear reminder remove <uid> |
Note that schedules are in UTC and use the following format:
{
"mon": ["12:30:00"],
"wed": ["10:00:00", "22:00:00"]
}
Integrations
Console
| Subcommand | Description | Usage |
|---|---|---|
| Color | Sets the color to display a user's name in | remembear integration console color <uid> <color_word> |
| Remove | Removes the color set for a user | remembear integration console remove <uid> |
Development
If you'd like to contribute to remembear's development, CONTRIBUTING.md will get you started. You can also open an issue for any bugs or feature requests, that's just as valuable as code contributions!