The Requests & Offers - MVP project aims to develop a Holochain application designed to facilitate the exchange of requests and offers within the hAppenings.community. This document outlines the specifications and requirements for the development of this application, focusing on its core functionalities, technologies, and user interactions.
The primary objective of this project is to create a simple, open-source Holochain application that enables Creators, Projects, and Developers to reach out to Holochain Advocates with specific requests for support. The application will be built on Holochain, incorporating TimeBanking and Local Exchange Trading System (LETS) design ideas and potentially including a Mutual Credit Currency component in post MVP versions.
This application is specifically tailored for the participants in the Holochain Ecosystem. At hAppenings.community, we have created our own definitions of the individuals who would be participants in Requests & Offers - MVP. The targeted audience includes:
- Holochain Creators/Projects/Developers: Individuals or groups actively involved in creating or developing projects within the Holochain ecosystem.
- Holochain Advocates: Individuals passionate about the Holochain technology, looking to support projects within the ecosystem.
- HoloHosts: Organizations or individuals hosting Holochain nodes, contributing to the network's infrastructure.
- User Creation: Users can create and retrieve their profile, categorized as "advocate" or "creator".
- User Retrieval: Users can retrieve their profile on other devices using credentials.
- User Linking: Users can be linked to agents, organizations, requests, offers, and projects.
- Custom Holochain Zome: A custom zome is used for managing user profiles within the application.
- hREA agents: User profiles are linked to hREA agents.
The User entry represents the user profile and its associated agents within the hAppenings.community. An agent can be a single user or a device associated with a user, allowing for the sharing of profiles across multiple devices. This entry includes various fields to capture essential information about the user, facilitating personalized experiences and targeted interactions within the community.
- UserUpdates: A link from the user create header to the user update headers.
- UserAgents: A link from the user to an agent. It is an index of all the agents that have the user.
- AllUsers: A link to the
usersanchor. It is an index of all the users. - MyUser: A link from the current agent to the user.
- UserRequests: A link from the user to a request. It is an index of all the requests that the user made.
- UserOffers: A link from the user to an offer. It is an index of all the offers that the user made.
- UserProjects: A link from the user to a project. It is an index of all the projects the user participates in.
- UserOrganizations: A link from the user to an organization. It is an index of all the organizations that the user participates in.
- UserSkills: A link from the user to a skill. It is an index of all the skills that have the user.
- Project and Organization Creation: Users can create projects and organizations, with projects owned by organizations. Projects have specific requirements and status.
The Project entry represents a project and its associated agents, including team members. Projects have specific requirements and status. Projects can be created by organizations or by users.
In hREA, projects are organizations classifiedAs Project.
- AllProjects: A link to the
projectsanchor. - ProjectCoordinators: A link from the project's to a user. It is an index of all the coordinators.
- ProjectContributors: A link from the project's to a user. It is an index of all the project contributors.
- ProjectCategories: A link from the project's to a category. It is an index of all the categories.
- ProjectRequests: A link from the project's to a request. It is an index of all the requests made by the project.
- ProjectOffers: A link from the project's to an offer. It is an index of all the offers made to the project.
The Organization entry represents an organization and its associated users and projects. Organizations are created by users.
In hREA, organization are agents classifiedAs Organization.
- AllOrganizations: A link to the
organizationsanchor. - OrganizationCoordinators: A link from the organization's to a user. It is an index of all the coordinators of the organization.
- OrganizationMembers: A link from the organization's to a user. It is an index of all the members of the organization.
- OrganizationProjects: A link from the organization's to a project. It is an index of all the projects under the organization.
- OrganizationCategories: A link from the organization's to a category. It is an index of all the categories under the organization.
- OrganizationRequests: A link from the organization's to a request. It is an index of all the requests made by the organization.
- OrganizationOffers: A link from the organization's to an offer. It is an index of all the offers made to the organization.
Projects and Organizations coordinators are integral to the operation and governance of projects and organizations within the network. They serve as the responsibles for the management and representation of their respective projects or organizations.
- Projects and organizations coordinators are individuals or groups designated to represent a project or organization within the network. They are onboarded and approved by the network's administrators to participate in the network, taking on the role of coordinators of projects or organizations.
- The projects and organizations coordinators can then fill out the project or organization profile and invite others to participate in the project or organization.
- Users can ask to join a project or organization.
- Projects and organizations coordinators has their own profile. It includes their skills, location, type, etc.
- Projects and organizations coordinators can make offers and requests for themselves or on behalf of their projects or organizations, such as fundraising, editing support, or testing of hApp.
- hREA Integration: Utilizes hREA for managing economic activities, including tracking resources, facilitating agreements, and matching needs.
- Request Creation: Users can create requests, linked to specific projects, organizations and skills.
- Offer Creation: Organizations, projects and users can create offers, linked to specific requests and projects.
- In hREA, requests and offers are
intentsandproposals. - For each exchange, there needs to be a mechanism for each party to agree that the exchange is complete. This could be integrated into the Request and Offer management sections of the application, allowing users to confirm the completion of an exchange directly within the application. This could be implemented as a confirmation step in the exchange process, ensuring that both parties have the opportunity to confirm the completion before the exchange is finalized.
- Skills: Users can create skills, which are used to filter users, requests and offers.
- Categories: Administrators can create categories, which are used to organize projects, requests and offers.
The Skill entry represents the skills associated with the users, projects, requests and offers. This in an anchor that contains a String that is the skill name.
In hREA, skills are Resource Specifications. They can be created only by offers and requests. A user need to create an offer that is the list of its skills to be able to display it in its profile.
- AllSkills: A link to the
skillsanchor. It is an index of all the skills. - SkillUsers: A link from the skill to a user. It is an index of all the users that have the skill.
- SkillProjects: A link from the skill to a project. It is an index of all the projects that have the skill.
- SkillRequests: A link from the skill to a request. It is an index of all the requests that have the skill.
- SkillOffers: A link from the skill to an offer. It is an index of all the offers that have the skill.
The Category entry represents the categories associated with projects and offers. This in an anchor that contains a String that is the category name.
The Category of an organization is the collection of the Category of its projects.
In hREA, categories are Resource Specifications classifiedAs {category}.
- AllCategories: A link to the
categoriesanchor. It is an index of all the categories. - CategoryProjects: A link from the category to a project. It is an index of all the projects that have the category.
- CategoryOffers: A link from the category to an offer. It is an index of all the offers related to the category.
Each page has a search functionality.
- Search Users: Users can search users by name, skills, categories, location, organizations and projects.
- Search Organizations: Users can search organizations by name, categories, projects.
- Search Projects: Users can search projects by name, skills, categories and organizations.
- Search Requests: Users can search requests by name, skills, categories, projects, organizations and users.
- Search Offers: Users can search offers by name, skills, categories, projects, organizations and users.
Administrators play a pivotal role in the governance and operation of the network, ensuring its integrity, security, and alignment with the community's objectives. Their responsibilities include:
- Verification of Users and Organizations: Administrators are tasked with verifying the authenticity and compliance of users and organizations within the network. This process is crucial for maintaining the integrity of the community and ensuring that all participants are legitimate.
- Project Creation by Verified Organizations: Projects within the network can be directly created by verified organizations. This streamlines the project initiation process for organizations that have already been vetted by the network administrators.
- Verification of Projects Not Managed by Verified Organizations: In cases where a user wishes to create a project that is not managed by a verified organization, the project must undergo a verification process by the network administrators. This ensures that all projects, regardless of their management structure, meet the network's standards and objectives.
- Moderator Role: Administrators can delegate moderator roles to other users. Moderators can perform most administrative tasks except for managing administrators themselves. This includes moderating projects, requests, and offers, ensuring content appropriateness and community guidelines compliance.
- Suspension: Administrators have the authority to temporarily or permanently suspend User profiles. This action can be taken in response to violations of community guidelines or other misconduct.
- Temporary Suspension: Administrators have the authority to temporarily suspend user profiles for a specified period.
- Indefinitive Suspension: Administrators have the authority to permanently suspend user profiles.
- Unsuspension: Administrators have the authority to unsuspend suspended user profiles.
- Suspension reason: Administrators can indicate the reason for a user's suspension. The user will be notified of the reason.
- Suspension history: Administrators can view the history of all the suspensions or for a specific user.
- Flagging System: Users have the ability to flag organizations, projects, requests, and offers for review by network administrators. This system allows the community to signal potentially inappropriate content or activities, prompting administrative review and action as necessary.
- Inbox: Administrators and moderators have access to an inbox that allows them to address user concerns, inquiries, and reports efficiently using the messaging system.
Key aspects of administrator and moderator roles and access include:
- Exclusive Access to Administration Zome and UI: Administrators and moderators are granted special access to the
Administrationzome and user interface, enabling them to effectively carry out their duties, including the verification of users, organizations, and projects. - Administrators anchor: The
administratorsanchor is an index of all the administrators of the network. It's what allows the recognition of the administrators. - Moderators anchor: The
moderatorsanchor is an index of all the moderators of the network. It's what allows the recognition of the moderators. - Progenitor pattern to recognize the first agent: The first agent in the network is designated as the progenitor. When the progenitorcreate his user profile, the agent becomes the first administrator.
- AdministratorsUser: A link from the
administratorsanchor to a user. It is an index of all the administrators of the network. - ModeratorsUser: A link from the
moderatorsanchor to a user. It is an index of all the moderators of the network.
Administrators have access to the Administration Dashboard, a specialized part of the user interface that includes pages for managing administrators, users, projects, organizations, requests, and offers. This dashboard also incorporates search functionality and special reports, providing administrators with comprehensive tools for network management.
Moderators have access to the same Administration Dashboard, but without the Administrators mangement page.
The Requests & Offers - MVP project is designed with a focus on facilitating collaboration and resource exchange within the hAppenings.community. To ensure a structured and efficient operation, the application defines specific roles and their associated permissions. These roles are crucial for managing the network's operations, ensuring its smooth functioning, and maintaining a healthy and supportive community.
- Onboarded/Approved: Advocates are individuals passionate about the Holochain technology, looking to support projects within the ecosystem. They are onboarded and approved to participate in the network by the network's administrators.
- User Profile: Advocates must file out their user profiles, including essential information and their areas of expertise.
- Offers: Advocates can offer their skills, talents, or resources to the network. This includes mentorship, brainstorming sessions, or any other form of support they wish to provide.
- Reporting: Advocates have access to reporting features, allowing them to view their exchanges and a general report of total exchanges for the month.
- Onboarded/Approved: Creators are individuals or groups actively involved in creating or developing projects within the Holochain ecosystem. They are onboarded and approved to participate in the network by the network's administrators.
- User Profile: Creators can file out their user profiles, including their skills, location, type, etc.
- Offers: Creators can make offers, including the skills and talents they wish to offer.
- Requests: Creators can make requests for themselves, such as mentoring, brainstorming time, or testing in the early days of their projects.
- Reporting: Creators can access reports on their exchanges and a general report of total exchanges for the month.
- Onboarded/Approved: Projects and organizations coordinators are individuals or groups designated to represent a project or organization within the network. They are onboarded and approved to participate in the network.
- Project Profile: Projects and organizations coordinators can file out the project profile, including the skills involved, location, type, etc.
- Offers: Projects and organizations coordinators can make offers, including the skills and talents they wish to offer.
- Requests: Projects and organizations coordinators can make requests for themselves and on behalf of their projects or organizations, such as fundraising, editing support, or testing of hApp.
- Description: A role that could be added in future versions to facilitate the matching of requests and offers more efficiently.
To facilitate real-time communication and negotiation among users, the application includes a messaging system. This system enables users to discuss details, negotiate terms, and settle agreements before finalizing exchanges through the acceptance or rejection of offers or requests.
- User-to-User Messaging: Allows users to communicate directly with one another, facilitating negotiations and discussions related to requests and offers.
- Messaging to Administrators: Provides a channel for users to send messages to network administrators. This feature is accessible through an inbox within the administration panel, allowing administrators to address user concerns, inquiries, and reports efficiently.
This messaging functionality supports the dynamic interaction between users, enhancing the collaborative environment and ensuring smooth transactions within the Requests & Offers - MVP platform.
Notification System: Implement a notification system to inform users when they have been suspended and why. This system should also notify the user once the suspension period ends.
- Use Case: Users can register and create user profile.
- Benefit: Facilitates the creation of a user-centric community, enabling personalized experiences and targeted interactions.
- Use Case: Users can recover their user profile, including their skills, projects, organizations, requests and offers.
- Benefit: Facilitates the creation of a user-centric community, enabling personalized experiences and targeted interactions. It allows the user to link multiple agents/devices to their user profile.
- Use Case: Users can create projects, specifying the skills needed and the scope of the project.
- Benefit: Allows for the organization and management of projects, ensuring that the right skills are matched with the right projects.
- Use Case: Users can create requests for specific skills or resources needed for their projects. These requests can be linked to specific projects, organizations, skills, and team members.
- Benefit: Provides a structured way for users to express their needs, ensuring that the right offers are matched with their requests. This functionality supports the efficient allocation of resources and skills within the community.
- Use Case: Users with relevant skills can create offers to contribute to projects, specifying the skills they are offering and how they intend to contribute.
- Benefit: Enables direct matching of skills with project needs, facilitating efficient collaboration.
- Use Case: Users can manage their requests and offers, including accepting offers from other users.
- Benefit: Provides a structured way for users to engage with each other, ensuring that interactions are organized and manageable.
- Use Case: Users can search for requests, offers, projects, organizations, users by name, skills, categories, organizations and projects.
- Benefit: Enhances the discoverability of resources within the community, promoting collaboration and innovation.
- Holo Hosting Overview: Leverages HoloHosts for robust and scalable infrastructure, contributing to the network's infrastructure and enhancing performance and reliability.
- Hosting Requirements: Requires a distributed network of HoloHosts for high availability and redundancy. The Holo Network can supply multiple HoloHosts for redundancy.
- Hosting Benefits: Fosters a decentralized and resilient infrastructure, aligning with Holochain ecosystem principles.
- Holochain: Core technology for building the application, ensuring local-first and peer-to-peer network capabilities.
- SvelteKit: Utilized for the guest/front-end, providing a modern and efficient framework for web development.
- Skeleton UI: A component library for building user interfaces with SvelteKit and Tailwind.
- hREA: hREA (Holochain Resource-Event-Agent) is an implementation of the Valueflows specification. It enables a transparent and trusted account of resource and information flows between decentralized and independent agents, across and within ecosystems.
Color palette :
This specification document outlines the key components and functionalities of the Requests & Offers - MVP project. By adhering to these specifications, developers can ensure the successful creation of a Holochain application that effectively facilitates the exchange of requests and offers within the hAppenings.community.