Skip to content

Latest commit

 

History

History
91 lines (72 loc) · 2.35 KB

README.md

File metadata and controls

91 lines (72 loc) · 2.35 KB
Raw

Quest Planner

Application is in-development and not ready for production use

A personal task-management system with an RPG theme and specific support for ADHD-related difficulties.

Developing

Starting a development server:

yarn dev

# or start the server and open the app in a new browser tab
yarn dev -- --open

Storybook and Tests

To run the storybook server:

yarn storybook

To run unit tests:

yarn test:unit

(Note: project is currently dependent on storybook and manual testing, so no real unit tests have been written yet)

Building

To create a production build:

yarn build

You can preview the production build with yarn preview.

TODO

  • Administration
    • Create design doc / tech spec
    • Create documentation
  • Core functionality
    • Allow user to create new quests
    • Allow user to mark quests as complete
    • Add confirmation modal for completing quests
    • Add personal setting to complet button
    • Allow user to unmark quests as completed
    • Allow user to abandon(delete) quests
    • Add confirmation modal to delete button
    • Allow user to view completed quests
    • Allow offline-mode / "install" functionality
    • Localization support
  • Misc
    • Enable quest categories ("Main Quest" and "Side Quest")
  • Sub-quests
    • Allow quests to be created inside a parent quest
    • Allow subquests to marked as optional or required
    • Prevent parent quest from completing if required subquests are in-complete
    • Allow parent quests to auto-complete when sub-quests complete
  • "Persistent Notifications"
    • Add deadlines
    • Add notification support
    • Configurable reminder times
    • Repeatable reminders
    • Stubborn reminders
  • Quest Rewards
    • Free-text reward descriptions
    • Tracked rewards as "resources"
    • Allow rewarded resources to be used as conditions for completing quests
  • Quest Chains
    • Repeatable-quests
      • Reschedule-on-completion
      • Repeat per time-unit
    • Direct follow-up quests
  • Hosted/shared quests
    • Allow user-defined sync servers
    • Enable hosted accounts with data sync
    • Allow quests to be recorded in a remote server
    • Allow read-only sharing of quests
    • Allow other users to be assigned to a quest
    • Allow group-quests (needs more design)