How 333ian/taskful-api works
Taskful API is a collaborative task-management backend. A client reaches account, house, and task endpoints; users manage profiles and house membership, then create task lists, tasks, and attachments within a house. Task status changes support progress tracking and point awards, while a scheduled job recalculates house statistics. The graph follows documented API routing and sampled module references; several implementation details, including social login, cloud storage, and point-signal behavior, are documented but not fully shown in the excerpts.
Main entry points: urls.py API URL config · task/viewsets.py Task API · house/viewsets.py House API · users/viewsets.py User API
Components 18
API routing
- API URL config
src/taskful_api/urls.py - User routes
src/users/router.py - House routes
src/house/router.py - Task routes
src/task/router.py
Identity
- User API
src/users/viewsets.py - User serializers
src/users/serializers.py - User profiles
src/users/models.py - OAuth services
House collaboration
- House API
src/house/viewsets.py - House serializers
src/house/serializers.py - Houses
src/house/models.py
Tasks and progress
- Task API
src/task/viewsets.py - Task serializers
src/task/serializers.py - Lists, tasks, attachments
src/task/models.py - Task point signals
src/task/signals.py
Statistics and storage
- Daily stats job
src/background_jobs/tasks.py - Google Cloud Storage
Other components
- API client
Connections 20
- API client → API URL config: calls API
README.md - API URL config → User routes: routes to
src/taskful_api/urls.py - API URL config → House routes: routes to
src/taskful_api/urls.py - API URL config → Task routes: routes to
src/taskful_api/urls.py - User routes → User API: registers
src/users/router.py - House routes → House API: registers
src/house/router.py - Task routes → Task API: registers
src/task/router.py - User API → User serializers: uses
src/users/viewsets.py - User serializers → User profiles: serializes
src/users/serializers.py - House API → House serializers: uses
src/house/viewsets.py - House serializers → Houses: serializes
src/house/serializers.py - House API → Houses: queries and updates
src/house/viewsets.py - Task API → Task serializers: uses
src/task/viewsets.py - Task serializers → Lists, tasks, attachments: serializes
src/task/serializers.py - Task API → Lists, tasks, attachments: queries and updates
src/task/viewsets.py - Task API → Task point signals: status change triggers
- Daily stats job → Houses: updates statistics
src/background_jobs/tasks.py - Daily stats job → Lists, tasks, attachments: counts tasks
src/background_jobs/tasks.py - OAuth services → User API: supports login
README.md - API client → Google Cloud Storage: uploads media
README.md