Chore Manager

Chore manager is a simple chore management application for taking care of household tasks.

Table of Contents

• Key Features
• Set Up Local Environment
• Testing
• Linting/Static Analysis
• Generate PWA Assets
• Related Projects
• Technologies

Key Features

• Keep track of chores and other tasks
• Control frequency of chore occurance over intervals of days, weeks, months, quarters, or years.
• View completion history of past chores
• Use Markdown to format chore description with rich information.
• iCalendar format support to integrate with calendar applications like Google Calendar

Set Up Local Environment

These instructions assume you are using Laravel Valet and Composer running on macOS.

1. Clone the repository to ~/Sites or wherever is parked in Valet
2. cd into the directory
3. sh .bin/init.sh
4. Optionally make changes to .env and .env.testing.

Testing

This application is built with a comprehensive test suite using PHPUnit.

To Run tests

composer test:unit

Linting/Static Analysis

This application is standardized and protected using Laravel Pint for linting/fixing and PHPStan/Larastan for static code analysis.

To run linter

composer test:lint

To run linter & fix errors automatically

composer test:fix

To run static analysis

composer test:types

Generate PWA Assets

This will generate all proper asset icons for the PWA. The source icon is located at public/icon.svg.

npm run generate-pwa-assets

Related Projects

• Chore Manager Mobile - Flutter application
• Chore Manager Magic Mirror Module

Technologies

Chore Manager is built using a TALL stack.

• Tailwind CSS
• Alpine.js
• Laravel
• Laravel Livewire