Tascurator is a web application designed to streamline the management of cleaning duties in a shared house. It offers a user-friendly platform for landlords to effortlessly create tasks with detailed instructions, invite tenants, and track progress. Tenants can quickly access, update, and report on their tasks, ensuring a well-organized living environment.

Key Features

For landlords:

• Task Management: Create and assign tasks that have detailed instructions, ensuring tenants understand their responsibilities.
• Task Instructions: Write detailed instructions or guidelines for each task using Markdown, which tenants can view on their screen. This eliminates the need for landlords to individually explain tasks to tenants.
• Tenant Management: Invite tenants to join the shared house and manage their participation via their emails.
• Progress Tracking: Monitor the status of each task and tenant at a glance. Landlords with multiple shared houses can view the progress of each house through a centralized dashboard.
• Rotation Scheduling: Set how often tasks are rotated among tenants—either every 1 or 2 weeks—to ensure a fair distribution of duties.
• Automatic Assignments: Task assignments are automatically updated based on the set rotation schedule, ensuring the workload is regularly distributed without manual intervention.
• Fair Task Distribution: The system balances task assignments by considering each tenant’s history, ensuring no tenant is overloaded with extra duties.

For tenants:

• Exclusive Access Links: Access the application via a tenant-exclusive link, with no sign-up required.
• Task Assignments: View and update the status of assigned tasks, and report progress directly to the landlord.
• Task Instructions: View detailed task instructions provided by the landlord, ensuring tenants understand what is expected.
• Future Task Previews: Check upcoming assignments up to three rotations in advance to prepare ahead of time.

Tech Stack

• Language: TypeScript 5.5
• Frameworks: Next.js 14 (with App Router), Hono (for Route Handlers)
• Styling: Tailwind CSS
• Components: shadcn/ui
• Form Handling: React Hook Form, zod
• Authentication: Auth.js
• Database: Vercel Postgres
• ORM: Prisma
• Email Services: Resend, React Email
• Testing: Vitest
• Linting/Formatting: ESLint, Prettier, Commitlint
• Deployment: Vercel

Getting Started for Developers

Take a look at the SETUP_GUIDE.md for more information on how to set up the project.

Documentations

TypeDoc Documentation

The TypeDoc documentation is available at https://tascurator.github.io/tascurator-frontend/.

Authors

• Akio Osawa - @akiomatic
  • Role: Lead Developer
• Rina Hara - @HrRn
  • Role: Frontend Developer, UI/UX Designer
• Satomi Nagano - @Akikaze1119
  • Role: Frontend Developer
• Yuki Saito - @yuki-92c
  • Role: Frontend Developer
• Kai Koide - @KaiKoide
  • Role: Backend Developer

License

Tascurator is open-sourced and licensed under the MIT License.