Never forget your household responsibilities again!

Housekeepy is a simple application that organizes your household and prevents fights about who should do what and when and how often. Given a list of members and regular household tasks, it automatically assigns these tasks each day and sends all members a notification on their chosen messaging service.

• Features
• Getting Started
  • Prerequisites
  • Setup
• Configuration
• Contributing
• License

• 📋 Automatic household task assignments
• ⏰ Daily reminders via SMS or WhatsApp
• 🔧 Browser interface for configuration

1. Register for an account on Twilio and create a Messaging Service.
2. Have Docker and Docker Compose installed.
3. If you want to host this service, prepare your domain name and install Certbot.

1. Clone the repository to your machine.

git clone https://github.com/ashiven/housekeepy.git

2. Fill out the .env file with the required variables.

TWILIO_ACCOUNT_SID=AC55...
TWILIO_AUTH_TOKEN=25fe...
WHATSAPP_SENDER=+155...
SMS_SENDER=+174...
TEMPLATE_SID=HX8b...
SERVICE_SID=MGf7...
ADMIN_PASSWORD=myAdminPassword
COOKIE_SECRET=jhkwe234kjhajhfa234
DOMAIN_NAME=myDomainName.com

3. Add tasks and household members to config.ini.

[Members]
Thomas : +4924352425243
Peter : +4923452354235

[Daily Tasks]
Throw out the trash :
Wipe the floor :

[Weekly Tasks]
Buy groceries :
Clean the living room :

[Monthly Tasks]
Clean the fridge :

4. Create an SSL certificate.

certbot certonly --standalone -d <domain-name>

5. Start the services.

docker compose up --detach --build

• Navigate to your domain name in the browser to open up the configuration interface.
• Any edit has to be confirmed with the ADMIN_PASSWORD configured in the .env file.
• Add members that should be notified about household tasks with phone numbers in the E.164 format.
• Add household tasks that need to be completed every day/week/month.
• Once a day at 12:00 PM, every member will be reminded of their tasks via SMS or WhatsApp.

Please feel free to submit a pull request or open an issue.

1. Fork the repository
2. Create a new branch: git checkout -b feature-name.
3. Make your changes
4. Push your branch: git push origin feature-name.
5. Submit a PR

This project is licensed under the MIT License.

GitHub @ashiven  ·  Twitter ashiven_