Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codehearts/remembear
🐻 Self-hosted web app for recurring reminders
https://github.com/codehearts/remembear
Last synced: 8 days ago
JSON representation
🐻 Self-hosted web app for recurring reminders
- Host: GitHub
- URL: https://github.com/codehearts/remembear
- Owner: codehearts
- License: mit
- Created: 2020-06-16T05:44:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T19:37:09.000Z (10 days ago)
- Last Synced: 2024-10-28T20:32:36.390Z (10 days ago)
- Language: Rust
- Size: 188 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 🐻 Remembear
[![Build Status][build-badge]][build-link] [![Code Coverage][coverage-badge]][coverage-link] [![Rust Crate][crates-badge]][crates-link] [![Documentation][docs-badge]][docs-link]
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](https://github.com/codehearts/remembear/blob/master/CONTRIBUTING.md) 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`:
```yaml
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 [subcommand..]`
#### Users
Subcommand | Description | Usage
---------- | ----------- | -----
Add | Adds a new user | `remembear user add `
List | Lists all users as a JSON array | `remembear user list`
Update | Updates an existing user | `remembear user update [-n name]`
Remove | Removes a user by their uid | `remembear user remove `
#### Reminders
Subcommand | Description | Usage
---------- | ----------- | -----
Add | Adds a new reminder | `remembear reminder add [assignees..]`
List | Lists all reminders as a JSON array | `remembear reminder list`
Update | Updates an existing reminder | `remembear reminder update [-n\|--name name] [-s\|--schedule schedule] [-a\|--assignees assignees..]`
Remove | Removes a reminder by its uid | `remembear reminder remove `
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 `
Remove | Removes the color set for a user | `remembear integration console remove `
## Development
If you'd like to contribute to remembear's development, [CONTRIBUTING.md](https://github.com/codehearts/remembear/blob/master/CONTRIBUTING.md) will get you started. You can also [open an issue](https://github.com/codehearts/remembear/issues/new) for any bugs or feature requests, that's just as valuable as code contributions!
[build-badge]: https://img.shields.io/github/workflow/status/codehearts/remembear/Build/master?logo=github&logoColor=white
[build-link]: https://github.com/codehearts/remembear/actions?query=workflow%3ABuild+branch%3Amaster
[coverage-badge]: https://img.shields.io/codecov/c/github/codehearts/remembear?logo=codecov&logoColor=white
[coverage-link]: https://codecov.io/gh/codehearts/remembear
[crates-badge]: https://img.shields.io/crates/v/remembear?logo=rust&logoColor=white
[crates-link]: https://crates.io/crates/remembear
[docs-badge]: https://docs.rs/remembear/badge.svg
[docs-link]: https://docs.rs/remembear