Update README.md

Fixed Formatting of README
This commit is contained in:
Matthew 2025-08-14 07:05:00 -07:00
parent 3da068547a
commit 46aefa64e3

View file

@ -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. 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 # 🚀 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.
✨ Key Features 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.
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. ## ✨ Key Features
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. - **Agent Dashboard** — Displays daily tasks, completion status, earned points, energy level, and story progress.
Progress Reset – Ability to reset an agent’s story and daily progress from the admin dashboard. - **Gamified Story Mode** — 30-day seasonal and light story arcs with daily interactive actions and energy costs.
SQLite Database Storage – All agent data, tasks, and templates are persisted locally. - **Energy System** — Agents complete tasks to gain energy, spend it on story actions, and track their journey.
Authentication System – Session-based admin login/logout with cookie handling. - **Task Templates** — Full CRUD (Create, Read, Update, Delete) interface for reusable task templates.
Responsive UI – TailwindCSS + React for a clean, mobile-friendly interface. - **Global Announcements** — Post and clear announcements visible to all agents.
Dark Mode Support – Full light/dark mode styling for comfortable use in any environment. - **Admin Control Center** — Secure login for super admins to manage agents, reset progress, update templates, and post announcements.
🛠 Endpoints & API - **Progress Reset** — Ability to reset an agent’s story and daily progress from the admin dashboard.
/login, /logout, /control-center – Admin authentication & dashboard - **SQLite Database Storage** — All agent data, tasks, and templates are persisted locally.
/get-all-data, /task-templates, /announcement – Data retrieval and management - **Authentication System** — Session-based admin login/logout with cookie handling.
/agent/:agentId/start-story – Begin seasonal or light story for an agent - **Responsive UI** — TailwindCSS + React for a clean, mobile-friendly interface.
/agent/:agentId/story-action – Process a story action with energy validation - **Dark Mode Support** — Full light/dark mode styling for comfortable use in any environment.
/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 ## 🛠 Endpoints & API
Seasonal Story Arc – Dark, immersive 30-day storyline with branching daily actions.
Light Story Arc – Wholesome, casual alternative with small-town themed actions. - `/login`, `/logout`, `/control-center` — Admin authentication & dashboard
Dynamic Outcomes – Every story action triggers unique text outcomes, saved to the daily log. - `/get-all-data`, `/task-templates`, `/announcement` — Data retrieval and management
This release establishes the foundation of the Personal Lines Task Tracker, combining productivity tracking with engaging narrative gameplay to boost agent engagement and performance. - `/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.