https://github.com/laxsrbija/chore-manager
Keep track of recurring household tasks
https://github.com/laxsrbija/chore-manager
chore-management chores recurring-tasks
Last synced: 2 months ago
JSON representation
Keep track of recurring household tasks
- Host: GitHub
- URL: https://github.com/laxsrbija/chore-manager
- Owner: laxsrbija
- License: mit
- Created: 2022-03-16T18:17:32.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T21:01:47.000Z (12 months ago)
- Last Synced: 2024-05-22T22:23:29.711Z (12 months ago)
- Topics: chore-management, chores, recurring-tasks
- Language: Java
- Homepage: https://laxsrbija.github.io/chore-manager/
- Size: 3.81 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## About the project
Chore Manager aims to help you keep track of your recurring
household tasks. The application allows users to create a customized list of chores,
set reminders for when they need to be completed, and track their progress over time.
The goal of this project is to make it easy to stay on top of your chores,
so you can spend more time doing the things you love.
## Features
* Track recurring tasks that either need to be done on a dynamic schedule or exact dates
* Organize tasks per items and categories
* Choose how many days in advance to notify users assigned to a specific task
* Notify other assigned users via email that a task has been completed
## Usage
The easiest way to deploy the Chore Manager is via Docker:
```
docker run -d -p 8080:8080 --name chore-manager \
-v /config/directory:/opt/chore-manager/resources \
-t laxsrbija/chore-manager:latest
```
The mounted host directory must contain an `application.properties` file used to configure the application.
A sample configuration can be found [here](chore-manager-backend/chore-manager-application/src/main/resources/application-dev.properties).
### Updates
Chore Manager utilises a rolling release; the `main` branch is considered stable,
and each new push will publish a new Docker image.
You can always stay up-to-date by using [Watchtower](https://github.com/containrrr/watchtower).
### Development environment
You can start the local environment via Docker Compose by executing `docker compose up` in the project root directory.
This will also start a MailCatcher instance for testing emails and preload demo data.
Use either of the following accounts to log in:
* [email protected] / demo
* [email protected] / demo
## Roadmap
While the core features are complete, the project is pretty much still a work in progress.
This section lists some upcoming features.
- **Manage all resources via a web UI**
Even though a web UI already exists, it can only be used to track existing tasks. All other
resources have to be managed by calling REST endpoints directly.
- **Tailor content to the current user**
The current authentication mechanisms exist mainly to prevent unauthorized access to the service.
Instead, list only the tasks assigned to the currently logged-in user.
- **Role-based authorization**
Provide access to management REST endpoints only to those users with the appropriate role. Also, allow
these users to manage others.
- **Alternative notification providers**
The system currently sends notifications exclusively via email.
Alternative notification providers can also be added (e.g. [ntfy](https://github.com/dschep/ntfy)).
## License
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.
Icon by [alimasykurm](https://thenounproject.com/alimasykurm/) from Noun Project.