Add plugin requirements
This commit is contained in:
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
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user