diff --git a/access-controls-and-privacy.md b/access-controls-and-privacy.md new file mode 100644 index 0000000..9fb66a9 --- /dev/null +++ b/access-controls-and-privacy.md @@ -0,0 +1,56 @@ +# Access Control and Privacy + +## User Groups and Permissions + +* Admin - Global privilages +* Rescue - can create/manage spaces +* Staff - can manage animals +* Social - can manage animal's feed +* Volenteers - can access Volunteer Portal +* User - user privilages, can not create spaces + +Each Space Represents an organization, charity, rescue, or business. + +# HumHub Space Menu + +* Animals +* Stream/Feed +* Gallery +* Rescue Calendar (Public calendar for public events) +* Staff Calendar (only visible for Admin/Rescue/Staff) +* Staff Tasks (only visible for Admin/Rescue/Staff) +* Volunteer Calendar (only visible for Admin/Rescue/Staff/Volunteers) +* Volunteer Tasks (only visible for Admin/Rescue/Staff/Volunteers) +* Rescue Settings (only visible for Admin/Rescue) + + +## Rescue Settings Page +>Settings for all custom plugins go here + +* Animal Intake Fields + +* Animal Profiles + * Animals we accept + +* Donations + * PayPal + * Stripe + * Bank Accounts + * General Donations + * Goals + * Need Specific Donation + * Goals + * Animal Donations + * Goals + * Goal Funded auto post + +* Rescue (Space) Profile + * Fields + * Header (html editor) + * Content (html editor) + * Footer (html editor) + + + + + diff --git a/custom-plugins.md b/custom-plugins.md new file mode 100644 index 0000000..687ebfc --- /dev/null +++ b/custom-plugins.md @@ -0,0 +1,225 @@ +# HumHub Custom Plugins for Animal Rescue Charities + +## Space Profiles Plugin +>Include the ability to modify/create Space Profile fields. + +### Access +* User: Read only +* Admin/Rescue: Manage + +### Descriptions +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. + +## Animal Management Plugin + +### Access +* User: Read only +* Admin/Rescue/Staff: Manage +* Social: Manage animal's feeds + +### Descriptions + +### Custom Page: Animal Profile +Each animal gets a profile page with their public details, an image gallery, donation options, adoption options & comments + +Animals are expected to be transfered regularly. In the code always refer to the animal by it's unigue id, so that when a transfer happens the ownership of the animal's profile is easily changed, the contents and control of the animal's feed is also transfered to the receiving Rescue. Existing posts for the Animal are marked as ReadOnly and can not be changed/removed from the animal's Feed. + +Additional content for Admin/Rescue/Staff: +* Transfer Options Block + * Displays a sorted list of each rescue (Space) that are a potential match for transfer. + * Uses Transfer Match Block as a template. + * Uses AI to search all available rescue Space, 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 (Space) + * Name, address, email, contact person + * Clear indicators for each met/unmet requirements + +### Custom feature: Social Media Feed for each animal +Users can follow animals (like they can follow users and spaces) and get posts from the animals. Which are posted by the Admin/Rescue/Staff/Social. + +### Custom Block/Page: Search Animal Profiles +Block: Search & Filter options, results displayed as paginated Animal Detail Blocks +For logged in Admin/Rescue/Staff: results displayed as Animal Management Blocks + +For the Page: +* Displays the Block +* on page load display all results (paginated) +* Display options for results: + * Grid Small + * Grid Large + * List (full width ) + +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) +* Is animal on site? + * Location if not on site + +Medical +* Current Physician Name, Business Name, email, address, phone, etc +* Previous Physician(s) (same fields as above) +* Medical concerns +* Medical file uploads +* 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 + +When completed it should include buttons to +* Post on the Space Feed +* Post on the Animal's Feed + +Plugin Settings: +* Auto post to the Space Feed +* Auto post to the Animal's Feed +* Template for the Space Feed +* Template for the Animal's Feed (templates define what and how information is included in the post) + + +### 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 + * username + * email + * address + * phone number + * Provided an Adoption Packet (zip file) containing all the animals available records. + * The animal is marked as Adopted + +2. Transfer to other Rescue on the HumHub Network + >It is recomended both Rescues discuss the details of a transfer before sending a request. + + * The sending Rescue creates a transfer request + * This ia an agreement between two Rescues. + * Include relevant details like + * transportation + * scheduling + * fees + * barter agreements + * The receiving Rescue will receive a Transfer Request Notification which they can reply with + * A message + * Conditions + * Accept + * Decline + * The sending Rescue recives a notification like + * Transfer Request Accepted + * Transfer Request Declined + * Transfer Request Message + * Transfer Request with Conditions + * If Accepted + * The transfer can occur as per the request agreement. + * The Receiving Rescue marks the Transfer as Complete upon receiving the animal. + * The animal is moved from the Sending Rescue's Space to the Receiving Rescue's Space. + +## Donation Plugin + +### Custom Integrations +* PayPal +* Stripe + +### Donation Options +* To the Rescue + * General Donations + * Need Specific + +* Animal Specific + * Goes to the rescue in posession of this animal toward their general expenses + +* Animal with Special Needs + * Goes to the rescue in posession of this animal toward their stated special need + * example: surgery, therapy, medical, transportation + + +### Optional Goals for Donations + +### Donation Block(s) (used in other blocks) + +* Customizable header text + * examples: + * in the display animal block: Support animal-name +* Display goal with a percentage bar if option set +* Display Donate button + +#### Placement of Donation Blocks (optional) +* In Animal Placement Blocks for each animal (by default) +* On the Space's Profile Page +* In emails, posts, messages + +## Pages for Calendar Events Plugin +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 + +## Volunteer Management Plugin +* 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 + +## Donor Perks Plugin +>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 diff --git a/project-requirements-clarification.md b/project-requirements-clarification.md index 00bf4dc..e2738f7 100644 --- a/project-requirements-clarification.md +++ b/project-requirements-clarification.md @@ -1,19 +1,4 @@ - - -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. @@ -25,140 +10,3 @@ 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 - -