Add plugin requirements
This commit is contained in:
kelinfoxy
43
project-requirements/animal-management-plugin.md
Normal file
43
project-requirements/animal-management-plugin.md
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
# Animal Management Plugin — Project Requirements
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
Manage animal profiles, intake, transfers, progress, and placement. Enable public and admin/staff workflows for animal care, transfer, and adoption.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- Animal profile pages (public details, gallery, donation/adoption options, comments)
|
||||||
|
- Unique animal IDs for transfer/ownership tracking
|
||||||
|
- Transfer options and AI-powered match suggestions
|
||||||
|
- Social media feed per animal (follow, post updates)
|
||||||
|
- Search/filter animal profiles (various display modes)
|
||||||
|
- Intake form (flexible fields, AI suggestions)
|
||||||
|
- Progress updates (routine care, medical, behavioral)
|
||||||
|
- Placement/adoption/transfer workflows
|
||||||
|
|
||||||
|
## Access Control
|
||||||
|
- User: Read only
|
||||||
|
- Admin/Rescue/Staff: Manage
|
||||||
|
- Social: Manage animal feeds
|
||||||
|
|
||||||
|
## Data Model
|
||||||
|
- Animal: id, name, breed, age, status, medical, gallery, owner, etc.
|
||||||
|
- Transfer: from/to, status, agreements, notifications
|
||||||
|
- Progress: vitals, notes, updates, media
|
||||||
|
|
||||||
|
## Workflows
|
||||||
|
- Intake: add new animal, flexible/unknown fields, AI suggestions
|
||||||
|
- Progress: regular updates, post to feeds
|
||||||
|
- Placement: adoption or transfer, notifications, agreements
|
||||||
|
|
||||||
|
## Integration Points
|
||||||
|
- AI for matching, meal/vitals suggestions, owner lookup
|
||||||
|
- Social feed, donation/adoption blocks
|
||||||
|
|
||||||
|
## Open Questions / Needs Clarification
|
||||||
|
- What fields are required for intake and profile?
|
||||||
|
- What AI integrations are required (meal plan, lineage, owner lookup)?
|
||||||
|
- What are the privacy requirements for animal data?
|
||||||
|
- How are transfer agreements and notifications managed?
|
||||||
|
- What is the approval process for posts/updates?
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
- Add more detail on transfer workflow, AI requirements, and privacy as needed.
|
||||||
32
project-requirements/calendar-events-plugin.md
Normal file
32
project-requirements/calendar-events-plugin.md
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
# Calendar Events Plugin — Project Requirements
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
Enhance event scheduling and marketing using the calendar module, with custom event pages and sidebar blocks for upcoming events.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- Use calendar module for event scheduling and invitations
|
||||||
|
- Custom event page with marketing info
|
||||||
|
- Sidebar block for upcoming events
|
||||||
|
|
||||||
|
## Access Control
|
||||||
|
- Users: View events, RSVP
|
||||||
|
- Admin/Rescue: Create/manage events
|
||||||
|
|
||||||
|
## Data Model
|
||||||
|
- Event: id, title, date/time, location, description, attendees, marketing info
|
||||||
|
|
||||||
|
## Workflows
|
||||||
|
- Admin creates event, adds marketing info
|
||||||
|
- Users view and RSVP to events
|
||||||
|
|
||||||
|
## Integration Points
|
||||||
|
- Calendar module
|
||||||
|
- Custom event/marketing pages
|
||||||
|
|
||||||
|
## Open Questions / Needs Clarification
|
||||||
|
- What additional marketing fields are needed?
|
||||||
|
- Should events support ticketing or donations?
|
||||||
|
- What notification/reminder options are required?
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
- Add more detail on marketing integration and notifications as needed.
|
||||||
36
project-requirements/donation-plugin.md
Normal file
36
project-requirements/donation-plugin.md
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
# Donation Plugin — Project Requirements
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
Enable donations to rescues, animals, and special needs via integrated payment processors. Support donation goals, blocks, and flexible placement in the UI.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- PayPal and Stripe integration
|
||||||
|
- Donation options: general, need-specific, animal-specific, special needs
|
||||||
|
- Donation goals and progress bars
|
||||||
|
- Customizable donation blocks (header, placement)
|
||||||
|
- Placement in animal profiles, space profiles, emails, posts, messages
|
||||||
|
|
||||||
|
## Access Control
|
||||||
|
- Users: Donate
|
||||||
|
- Admin/Rescue: Configure options, view/manage donations
|
||||||
|
|
||||||
|
## Data Model
|
||||||
|
- Donation: amount, donor, recipient (rescue/animal/need), goal, status
|
||||||
|
- Block: header, goal, placement
|
||||||
|
|
||||||
|
## Workflows
|
||||||
|
- User selects donation type and completes payment
|
||||||
|
- Admin configures donation options and goals
|
||||||
|
|
||||||
|
## Integration Points
|
||||||
|
- PayPal, Stripe APIs
|
||||||
|
- UI blocks in various locations
|
||||||
|
|
||||||
|
## Open Questions / Needs Clarification
|
||||||
|
- What donor information is required (privacy, receipts)?
|
||||||
|
- How are recurring donations managed?
|
||||||
|
- What reporting is needed for admins?
|
||||||
|
- Are there tax receipt requirements?
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
- Add more detail on reporting, recurring donations, and compliance as needed.
|
||||||
37
project-requirements/donor-perks-plugin.md
Normal file
37
project-requirements/donor-perks-plugin.md
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
# Donor Perks Plugin — Project Requirements
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
Engage and reward donors and supporting businesses/organizations with perks, achievement badges, and publicity opportunities.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- Business/org pages under spaces for major supporters
|
||||||
|
- Publicity and achievement stories
|
||||||
|
- Achievement badges for donors (e.g., first time, feed/stable a horse)
|
||||||
|
- Badge display by user icons
|
||||||
|
|
||||||
|
## Access Control
|
||||||
|
- Donors: Earn badges, create org pages (by invite)
|
||||||
|
- Admin/Rescue: Invite, manage org pages, assign badges
|
||||||
|
|
||||||
|
## Data Model
|
||||||
|
- Donor: id, name, badges, org page link
|
||||||
|
- Organization: id, name, page, contributions
|
||||||
|
- Badge: id, name, criteria
|
||||||
|
|
||||||
|
## Workflows
|
||||||
|
- Admin invites/supporter creates org page
|
||||||
|
- Donors earn badges for contributions
|
||||||
|
- Badges displayed in UI
|
||||||
|
|
||||||
|
## Integration Points
|
||||||
|
- Social media sharing
|
||||||
|
- Badge display in UI
|
||||||
|
|
||||||
|
## Open Questions / Needs Clarification
|
||||||
|
- What are the criteria for each badge?
|
||||||
|
- How are org pages approved/managed?
|
||||||
|
- What info is required for org pages?
|
||||||
|
- How is badge progress tracked?
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
- Add more detail on badge criteria, org page management, and publicity as needed.
|
||||||
62
project-requirements/space-profiles-plugin.md
Normal file
62
project-requirements/space-profiles-plugin.md
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
# Space Profiles Plugin — Project Requirements
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
Enable organizations (spaces) to have customizable, template-driven profile pages with branding, contact info, and organization-specific data. Supports different templates for rescues, charities, and businesses.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- Customizable space profile fields (address, phone, hours, people, location, description, mission, etc.)
|
||||||
|
- Template system for different organization types
|
||||||
|
- Search Animal Profiles block integration
|
||||||
|
- HTML/CSS insertion points for advanced customization
|
||||||
|
|
||||||
|
## Access Control
|
||||||
|
- User: Read only
|
||||||
|
- Admin/Rescue: Manage (edit, configure)
|
||||||
|
|
||||||
|
## Data Model
|
||||||
|
- Space (organization) info: name, type, contact, location, etc.
|
||||||
|
- Template selection and custom fields
|
||||||
|
- Branding assets (logo, images)
|
||||||
|
|
||||||
|
## Workflows
|
||||||
|
- Admin/Rescue configures and customizes their space profile
|
||||||
|
- Users view public profiles
|
||||||
|
|
||||||
|
## Integration Points
|
||||||
|
- Animal search block
|
||||||
|
- Custom HTML/CSS
|
||||||
|
|
||||||
|
## Open Questions / Needs Clarification
|
||||||
|
- What additional templates are needed beyond animal rescue?
|
||||||
|
>Only animal rescue for now. Leaving the door open for future expansion
|
||||||
|
- What fields should be mandatory vs. optional?
|
||||||
|
>Only the html fields should be optional
|
||||||
|
- What level of HTML/CSS customization is allowed (security)?
|
||||||
|
> User can modify the HTML/CSS of the profile page, but not any other part of the HumHub interface. No js.
|
||||||
|
- Should there be approval for public changes?
|
||||||
|
>no
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
- Add more details on template requirements and field validation as needed.
|
||||||
|
>standard validation for all contact info fields, reasonable size limits on image uploads
|
||||||
|
|
||||||
|
# Fields
|
||||||
|
* rescue name
|
||||||
|
* address
|
||||||
|
* city
|
||||||
|
* state
|
||||||
|
* zip
|
||||||
|
* email
|
||||||
|
* phone
|
||||||
|
* animals we accept
|
||||||
|
|
||||||
|
* description
|
||||||
|
* mission statement
|
||||||
|
* header (html)
|
||||||
|
* body (html)
|
||||||
|
* footer (html)
|
||||||
|
* icon
|
||||||
|
* background image
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
36
project-requirements/volunteer-management-plugin.md
Normal file
36
project-requirements/volunteer-management-plugin.md
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
# Volunteer Management Plugin — Project Requirements
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
Manage volunteer signups, approvals, and scheduling. Enable owners/managers to coordinate volunteer hours and allow volunteers to request and schedule work.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- Volunteer signup/request workflow
|
||||||
|
- Approval/denial messaging
|
||||||
|
- Volunteer hour scheduling by owner/manager
|
||||||
|
- Approved volunteers can self-schedule
|
||||||
|
|
||||||
|
## Access Control
|
||||||
|
- Anyone: Request to volunteer
|
||||||
|
- Owner/Group Manager: Approve/deny, schedule hours
|
||||||
|
- Approved Volunteers: Schedule work hours
|
||||||
|
|
||||||
|
## Data Model
|
||||||
|
- Volunteer: id, name, contact, status, approved hours
|
||||||
|
- Schedule: available hours, assigned hours
|
||||||
|
|
||||||
|
## Workflows
|
||||||
|
- User requests to volunteer
|
||||||
|
- Manager approves/denies, messages user
|
||||||
|
- Approved volunteer schedules work
|
||||||
|
|
||||||
|
## Integration Points
|
||||||
|
- Messaging/notifications
|
||||||
|
- Calendar/scheduling
|
||||||
|
|
||||||
|
## Open Questions / Needs Clarification
|
||||||
|
- What information is required for volunteer signup?
|
||||||
|
- How are background checks or requirements handled?
|
||||||
|
- What reporting is needed for hours worked?
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
- Add more detail on background checks, reporting, and scheduling as needed.
|
||||||
Reference in New Issue
Block a user