From 46aefa64e3d00675152da806b01ebbf32c81921e Mon Sep 17 00:00:00 2001 From: Matthew Date: Thu, 14 Aug 2025 07:05:00 -0700 Subject: [PATCH] Update README.md Fixed Formatting of README --- README.md | 69 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 42 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index af1eed7..56d1279 100644 --- a/README.md +++ b/README.md @@ -2,31 +2,46 @@ A gamified task management and progress tracking tool designed for insurance agency workflows. Built in Node-RED with a clean React-based UI, SQLite persistence, and support for daily task tracking, seasonal story progression, and admin control features. -πŸš€ Version 1.0 – Initial Release -The first official release of the Personal Lines Task Tracker – a gamified task management and progress tracking tool designed for insurance agency workflows. Built in Node-RED with a clean React-based UI, SQLite persistence, and support for daily task tracking, seasonal story progression, and admin control features. +# πŸš€ Version 1.0 – Initial Release -✨ Key Features -Agent Dashboard – Displays daily tasks, completion status, earned points, energy level, and story progress. -Gamified Story Mode – 30-day seasonal and light story arcs with daily interactive actions and energy costs. -Energy System – Agents complete tasks to gain energy, spend it on story actions, and track their journey. -Task Templates – Full CRUD (Create, Read, Update, Delete) interface for reusable task templates. -Global Announcements – Post and clear announcements visible to all agents. -Admin Control Center – Secure login for super admins to manage agents, reset progress, update templates, and post announcements. -Progress Reset – Ability to reset an agent’s story and daily progress from the admin dashboard. -SQLite Database Storage – All agent data, tasks, and templates are persisted locally. -Authentication System – Session-based admin login/logout with cookie handling. -Responsive UI – TailwindCSS + React for a clean, mobile-friendly interface. -Dark Mode Support – Full light/dark mode styling for comfortable use in any environment. -πŸ›  Endpoints & API -/login, /logout, /control-center – Admin authentication & dashboard -/get-all-data, /task-templates, /announcement – Data retrieval and management -/agent/:agentId/start-story – Begin seasonal or light story for an agent -/agent/:agentId/story-action – Process a story action with energy validation -/agent/:agentId/reset – Reset an agent’s story progress and daily tasks -/tasks/:agentId/:date/:taskId/status – Update task status for a given date -/agents/:id – Delete an agent -πŸ“– Story Content -Seasonal Story Arc – Dark, immersive 30-day storyline with branching daily actions. -Light Story Arc – Wholesome, casual alternative with small-town themed actions. -Dynamic Outcomes – Every story action triggers unique text outcomes, saved to the daily log. -This release establishes the foundation of the Personal Lines Task Tracker, combining productivity tracking with engaging narrative gameplay to boost agent engagement and performance. \ No newline at end of file +The first official release of the **Personal Lines Task Tracker** β€” a gamified task management and progress tracking tool designed for insurance agency workflows. Built in **Node-RED** with a clean **React-based UI**, **SQLite** persistence, and support for daily task tracking, seasonal story progression, and admin control features. + +--- + +## ✨ Key Features + +- **Agent Dashboard** β€” Displays daily tasks, completion status, earned points, energy level, and story progress. +- **Gamified Story Mode** β€” 30-day seasonal and light story arcs with daily interactive actions and energy costs. +- **Energy System** β€” Agents complete tasks to gain energy, spend it on story actions, and track their journey. +- **Task Templates** β€” Full CRUD (Create, Read, Update, Delete) interface for reusable task templates. +- **Global Announcements** β€” Post and clear announcements visible to all agents. +- **Admin Control Center** β€” Secure login for super admins to manage agents, reset progress, update templates, and post announcements. +- **Progress Reset** β€” Ability to reset an agent’s story and daily progress from the admin dashboard. +- **SQLite Database Storage** β€” All agent data, tasks, and templates are persisted locally. +- **Authentication System** β€” Session-based admin login/logout with cookie handling. +- **Responsive UI** β€” TailwindCSS + React for a clean, mobile-friendly interface. +- **Dark Mode Support** β€” Full light/dark mode styling for comfortable use in any environment. + +--- + +## πŸ›  Endpoints & API + +- `/login`, `/logout`, `/control-center` β€” Admin authentication & dashboard +- `/get-all-data`, `/task-templates`, `/announcement` β€” Data retrieval and management +- `/agent/:agentId/start-story` β€” Begin seasonal or light story for an agent +- `/agent/:agentId/story-action` β€” Process a story action with energy validation +- `/agent/:agentId/reset` β€” Reset an agent’s story progress and daily tasks +- `/tasks/:agentId/:date/:taskId/status` β€” Update task status for a given date +- `/agents/:id` β€” Delete an agent + +--- + +## πŸ“– Story Content + +- **Seasonal Story Arc** β€” Dark, immersive 30-day storyline with branching daily actions. +- **Light Story Arc** β€” Wholesome, casual alternative with small-town themed actions. +- **Dynamic Outcomes** β€” Every story action triggers unique text outcomes, saved to the daily log. + +--- + +This release establishes the foundation of the **Personal Lines Task Tracker**, combining productivity tracking with engaging narrative gameplay to boost agent engagement and performance.