README.md

Requests and Offers

A hAppenings.community project facilitating exchange between Holochain creators, developers, advocates, projects, and organizations. Built with Holochain, it provides an agent-centric, distributed marketplace for requests and offers.

Quick Links

• Community Website
• Litepaper
• Discord Community

Documentation

📚 Full Documentation

Key Documentation Sections

• Guides

  • Getting Started
  • Installation
  • Contributing

• Technical Documentation

  • Architecture Overview
  • hREA Integration
  • Zome Documentation
    • Users Organizations
    • Administration

• Specifications

  • MVP Requirements
  • Feature Specifications
  • User Roles
  • Technical Architecture
  • Use Cases

Quick Start

Prerequisites

• Holochain Development Environment
• Node.js 16+
• pnpm 9.7.0+

Setup

# Clone repository
git clone https://github.com/Happening-Community/requests-and-offers.git
cd requests-and-offers

# Enter nix shell
nix develop

# Install dependencies
pnpm install

Development

# Start with 2 agents (default)
pnpm start

# Start with custom number of agents
AGENTS=3 pnpm start

# Start with Tauri (desktop app)
pnpm start:tauri

This will:

• Create a network of agents
• Start the UI for each agent
• Launch the Holochain Playground for conductor introspection

Testing

# Run all tests
pnpm test

# Frontend tests
pnpm test:ui

# Individual zome tests
pnpm test:misc           # Misc functionality
pnpm test:users          # Users Organizations
pnpm test:administration # Administration
pnpm test:organizations  # Organizations
pnpm test:status        # Status module

Building

# Build zomes
pnpm build:zomes

# Build complete hApp
pnpm build:happ

# Package for distribution
pnpm package

Project Structure

requests-and-offers/
├── dnas/                    # Holochain DNA
│   └── requests_and_offers/
│       └── zomes/          # DNA zomes
│           ├── coordinator/ # Coordinator zomes
│           └── integrity/  # Integrity zomes
├── ui/                     # SvelteKit frontend
│   ├── src/
│   │   ├── lib/           # Shared components
│   │   ├── routes/        # SvelteKit routes
│   │   ├── services/      # Holochain services
│   │   └── stores/        # State management
├── tests/                  # Tryorama tests
└── documentation/         # Project documentation
    ├── guides/           # Development guides
    ├── specifications/   # Project specifications
    └── technical/       # Technical documentation

Feature Development

See our Contributing Guide for detailed development workflow:

1. DNA Development

   • Implement zome functionality
   • Write Tryorama tests
   • Document entry and link types

2. Service Layer

   • Create Holochain services
   • Implement store management
   • Handle state updates

3. UI Implementation

   • Build reusable components
   • Create feature pages
   • Integrate with stores

Community

• Join our Discord
• Visit hAppenings Community
• Follow development on GitHub

License

This project is licensed under Cryptographic Autonomy License version 1.0