diff --git a/Plan.md b/Plan.md index b903618..eed7e49 100644 --- a/Plan.md +++ b/Plan.md @@ -9,8 +9,17 @@ This plan outlines the steps to move from the current HumHub setup to a detailed ### Phase 1: Requirements Clarification & Context Gathering 1. **Inventory Current State** - - List all installed HumHub modules and their configuration status. - - Document user roles, spaces, and permissions currently set up. + - **Installed HumHub Modules:** + - Custom Pages (custom_pages, v1.10.15): Create custom pages and widgets. + - Gallery (gallery, v1.5.5): Adds galleries to spaces and profiles. + - Tasks (tasks, v1.8.8): Task and project management. + - Additional modules present: auth-keycloak, cfiles, content-bookmarks, dark-mode, fcm-push, linklist, mail, menu-manager, newmembers, online-users, polls, popover-vcard, questions, reportcontent, sharebetween, sms, socialshare, text-editor, usermap, virus-scanner, weather, wiki. + - **Users:** + - Kelin Reij (kelinshomelab@gmail.com): admin + - April Abigail (aprilabigail@example.com): Groups: users, rescue, charity; Spaces: ct-horse-rescue + - Body Bigs (bodybrigs@example.com): user + - **Spaces:** + - ct-horse-rescue: owned by April Abigail 2. **Clarify Feature Requirements** - For each major feature (custom pages, profiles, resource/event/animal/volunteer/donor management, intelligent matching, donor perks), gather: - Detailed functional requirements diff --git a/README-FIRST.md b/README-FIRST.md new file mode 100644 index 0000000..7406a04 --- /dev/null +++ b/README-FIRST.md @@ -0,0 +1,10 @@ +This folder contains a project mockup created on aistudio.google.com +It was created before deciding to use HumHub instead of a completely custom solution. + +It was designed by the UI/UX designer as a mockup for what the interface should look like, what info should be displayed and what the workflow would look & function. + +It includes multiple signin portals, which is being consolendated into a single humhub account + +It serves as reference for the desired apperance, style & workflow +It it not something we are developing further, but can pull from as needed. + diff --git a/project-requirements-clarification.md b/project-requirements-clarification.md new file mode 100644 index 0000000..00bf4dc --- /dev/null +++ b/project-requirements-clarification.md @@ -0,0 +1,164 @@ + + + +2. **Clarify Feature Requirements** + - For each major feature (custom pages, profiles, resource/event/animal/volunteer/donor management, intelligent matching, donor perks), gather: + - Detailed functional requirements + - Data model needs + - Workflow expectations + - Access control/privacy requirements + - Clarify what "configurable" means for each interface. + - Define requirements for integrations (donations, social media, etc.). + +# Feature clarifications + +This project is going to have several componets, break it up into multiple plugins that will work together. + +## Resource & Service Tags (no need for a plugin) +>Include the ability to modify/create new resources and resource types. + +Resources are infrastructure, equipment & supplies. Like Surgical Suites/Kennels/Stables, Portable X-Ray/Bridal/Sadle & medications/dietary suppliments + +Services are things like Neuter/Spay, Grooming, Keneling, Stabling, Physical Rehabilitation, Training, Pet Sitting, +Vetrinarian On call + +Purpose: helpful for matching individual needs of the animal to the best rescue/adoption + +Usage : Will be displayed in multiple places. + + +## Custom Plugin: Space Profiles +>Include the ability to modify/create Space Profile fields. + +Each Space is an organization, charity, rescue, or business. + +A Space Profile is a landing page for that organization that the owner can customize with branding and information. +It uses templates to allow for different use cases + +Use case 1: Animal Rescue Center Template + +Includes fields like address, phone numbers, business hours, people (employees), location on a map, description, mission statement, etc +Includes Search Animal Profiles Block +Includes the ability to insert html/css into various parts of the templated page. + + +## Custom Plugin: Animal Management + +### Custom Page: Animal Profile +Each animal gets a profile page with their public details, an image gallery, donation options, adoption options, comments + +Additional content for owner/group-manager/admin: +* Transfer Options Block + * Displays a sorted list of each rescue (Spaces) that are a potential match for transfer. + * Uses Transfer Match Block as a template. + * Uses AI to search all available rescue Spaces, and generates results based on what would be the best fit for the animal given available resources and the animals needs + +* Transfer Match Block + * Displays the details of the rescue (Spaces) + * Name, address, email, Spaces link + * Clear indicators for each met/unmet requirements + +### Custom Block/Page: Search Animal Profiles +Block: Search & Filter options, results displayed as Animal Detail Blocks +For logged in owner/group-manager/admin: results displayed as Animal Management Blocks + +Page: Dispalys the Block +The block is also used elsewhere + +### Custom Block: Animal Details +Template for how to display a single animal block element for browsing/searching +* Modern design, rounded corners, thin borders +* Designed for desktop & mobile experience +* Includes Donation/Adoption links & medical concerns + + +### Custom Page/Form: Intake Page: for new animal intake +>No required fields, expect to have unknown information +>Include the ability to modify/create new fields + +* Breed +* DOB +* Age (calculated if DOB is known) +* Date of most recent vitals +* Weight & other vitals +* Ideal weight & vitals Comparison for this age of this breed (auto generated by AI) +* Recomended Meal plan (AI suggestions auto generated, require acceptance) +* Back story +* Lineage +* Previous owner(s) (AI tools to find contact info based on clues) + +* Current Physician Name, Business Name, email, address, phone, etc +* Previous Physician(s) (same fields as above) +* Medical concerns +* Medical care requirements +* Medical care monthly cost +* Meal Plan monthly cost + +### Custom Page/Form: Progress Updates +>Make routine care engagement opertunities +>Great job for anyone who likes to take selfies + +The animals will require regular care, while doing so the user should look for things they could post about this animal. +Cute selfies with the animal, heart-touching stories, odd behaviours, therapy progress, behaviorial changes. + +User should perform regualar progress updates at scheduled intervals. + +Progress Update Fields: +* Weight & Vitals +* Behavioral Notes +* Meal Plan Changes +* Housing Changes + +If medical in nature: +* New Concerns +* Existing Concerns +* Medical Recomendations + + +### Custom Page/Form: Placement Page +>Used when moving an animal out of your care. +>Different options for different scenarios + +1. Adoption by individual + * New Owner name, email, address, phone number + * New Owner is provided an Adoption Packet (zip file) containing all the animals available records. + * The animal is marked as Adopted +2. Transfer to other Rescue + * Rescue name, HumHub Space(if available), email, address, phone number + * If receiving Rescue is on the HumHub netowrk, they will receive a Transfer Request which they can reply to with a message, set conditions, accept or reject. + * If receiving Rescue is not on the HumHub network, they will receive a Transfer Packet (zip file, same content as Adoption Packet) + * The animal is marked as Transfered + + +## Custom Plugin: Pages for Calendar Events + +Use calendar module to schedule events and invite attendees. +Use a custom page that will display an event from the calendar and additional event & marketing info +Create a sidebar block that shows upcoming events + + +## Custom Plugin: Volunteers + +* Time management platform + * Owner/Group Manager can schedule Volunteer Hours available for volunteers to work + * Anyone can request to be a volunteer + * Owner/Group Manager can message/approve/deny the request + * Approved Volunteers can schedule work hours within the Volunteer Hours + + +## Custom Plugin: Donor Perks +>Donors are critical to charitable orginizations. +>Use cross platform social media to engage potential doners. + +If a business or orginization is providing substancial support (not always monetary in nature), +invite them to create a page for their orginization under your Space to highlight their contributions and accomplishments. +This gives them publicity & community engagement to attract new business. It gives you documented success stories & publicity potential. + +Use achievement badges by user icons for engagement and fun. + +Achievements: +* First Time Donor +* Feed a Horse for a Week/Month/Year +* Stable a Horse for a Week/Month/Year + +