plan.md

Plan.md

@@ -0,0 +1,72 @@
+## Plan: HumHub Animal Rescue Project — Discovery & Planning
+
+**TL;DR:**  
+This plan outlines the steps to move from the current HumHub setup to a detailed, actionable implementation plan for the Animal Rescue platform. The focus is on clarifying requirements, identifying dependencies, and structuring the project for effective execution.
+
+---
+
+**Steps**
+
+### 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.
+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.).
+3. **Identify Technical Constraints**
+	- Determine which features can be built with existing HumHub modules vs. which require custom development.
+	- Identify any third-party dependencies or APIs needed.
+
+### Phase 2: Design & Planning
+4. **Draft Data Models**
+	- Propose data structures for animals, events, resources, volunteers, donors, and organizations.
+5. **Workflow Mapping**
+	- Create workflow diagrams for key processes (animal intake, event creation, volunteer scheduling, etc.).
+6. **UI/UX Planning**
+	- Outline interface requirements for each user type and feature.
+7. **Security & Privacy**
+	- Define access control, privacy, and data retention policies.
+
+### Phase 3: Implementation Roadmap
+8. **Prioritize Features**
+	- Sequence features for phased implementation (MVP, Phase 2, etc.).
+9. **Module Configuration & Customization**
+	- Plan configuration of existing modules and scope for custom modules/pages.
+10. **Integration Planning**
+	 - Identify and plan for payment, social media, and other integrations.
+
+---
+
+**Relevant files**
+- README.md — Project vision, goals, and high-level requirements
+
+---
+
+**Verification**
+1. Review and confirm the inventory of modules, users, and spaces.
+2. Validate requirements and workflows with stakeholders (admins, rescue owners, volunteers, donors).
+3. Ensure all technical and integration requirements are documented.
+4. Confirm that data models and workflows align with organizational needs.
+5. Review security and privacy plans for compliance.
+
+---
+
+**Decisions**
+- The plan is strictly for discovery and requirements gathering; no implementation will begin until all ambiguities are resolved.
+- All features and workflows will be mapped before any code or configuration changes.
+- Scope includes only what is outlined in the README and clarified during requirements gathering.
+
+---
+
+**Further Considerations**
+1. Should the MVP focus on a subset of features (e.g., animal intake, event management) or aim for broad coverage?
+2. What is the preferred method for gathering detailed requirements (workshops, interviews, surveys)?
+3. Are there existing HumHub modules or third-party tools that can be leveraged to reduce custom development?
+
+---

README.md

@@ -0,0 +1,67 @@
+# HumHub Animal Rescue Project
+
+I want to use a self hosted humhub service for Animal Rescue organization for rescues, charities & potential doners.
+
+Current status: humhub installed and accessible at https://hub.kelinreij.duckdns.org 3 users created. One space created for CT Horse Rescue. Several modules installed, some unconfigured. 
+
+## Goals:
+*  Create several custom pages that can be used by all rescues.
+*  Create new functionality
+    * Profiles for spaces (charity/rescue):
+    * Contact info, location, descripttion, people, resources, capacity, gallery of animals in the charity/rescue, events, donation options, volunteer options
+
+    * Resource management: 
+        * Specialized equipment
+        * Equipment tracking
+        * Resource sharing between charities/rescues:
+
+    * Event management: 
+      * charitable
+      * openhouse
+      * festival
+      * adoption
+
+    * Animal management: 
+      * Intake, medical & documentation
+      * Gallery, social media & marketing opertunities
+      * Placement & adoption
+
+    * Volumteer management: 
+      * Recruitment & engagement
+      * Scheduling
+      * Sharing
+
+    * Intelegent placement matching animal to best suited rescue
+
+    * Donor support options: 
+      * Donation goals per animal/event/monthly/annual
+      * Reocurring monthly donations (general/animal/event/etc)
+
+    * Donor perks:
+      * Businesses/organizations can create a page to promote their business and highlight their contributions
+
+## Interfaces:
+  * Settings: owner/admin
+  * Space Profile: public
+  * Space Profile editor: owner/admin
+  * Resources: configurable
+  * Events: configurable
+  * Animals: configurable
+  * Volunteers: configurable
+  * Donors: configurable
+
+
+## Workflows
+### Space owner/group-manager/admin 
+  * Configure the custom space settings
+  * Edits the Space Profile & Space Page 
+  * Adds/Edits the Equipment
+  * Add/Edit Events
+  * Perform Animal Intake
+  * Add/Edit Animal medical, documentation & gallery
+  * Recruit, manage, interact & schedule volunteers
+  * Interact with donors
+
+
+
+