gvil v0.0.1

Resource-Sharing Platform

Table of Contents

• Overview
• Personas
• Features
  • Joining the System
  • Resource Management
  • Matching and Notifications
  • Transactions
• Development
  • Structure

Overview

This platform aims to facilitate the sharing of resources between different entities, such as organizations and individuals. It matches available resources with those in need and notifies both parties for further action.

Personas

Organizations

Entities like hospitals, volunteer centers, and military bases that have resources to offer or are in need of specific resources.

{
  "id": "123",
  "name": "hospital",
  "desc": "a good place to volunteer"
}

Individuals

People who either want to donate resources or are seeking specific resources for themselves.

{
  "id": "789",
  "name": "baryo",
  "available": {
    "food box": [
      {
        "quantity": 3,
        "location": "TLV"
      }
    ]
  }

}

Features

Joining the System

• Users can either register manually or be dynamically created based on data from forums, WhatsApp groups, etc.

Resource Management

• Each persona (organization or individual) can list resources they have available or are missing.
• Resources can have additional details such as quantity, location, time, and category.
• Examples:
  • 3 combat-vests available in TLV
  • Need 20 volunteers in Beer Sheva tomorrow

{
  "available": {
    "food box": [
      {
        "quantity": 3,
        "location": "TLV"
      }
    ]
  }
}

Matching and Notifications

• The system automatically matches available resources with missing resources.
• When a match is found, both parties are alerted via selected channel.

sequenceDiagram
  User1->>System: List available resources
  User2->>System: List missing resources
  System->>WhatsApp Bot: Found a match
  WhatsApp Bot->>User1: Alert
  WhatsApp Bot->>User2: Alert

Transactions

• Parties can communicate directly to finalize the transaction.
• Both parties can confirm the transaction, updating the quantity of resources available or missing.
• The system supports multi-resource transactions.

graph TD
  X[User X: Has vests] --> Z[User Z: Can transport]
  Z --> Y[User Y: Needs vests]

Development

Structure

packages:
    ts: # pure TS functunality
     src:
       ts.ts # types 
       
     

Install

Run yarn

Building

Run yarn build to build all workspace.

Run npx nx build ts to build the specific package.

Generate new package

Run name=my_lib yarn genwts to generate ts lib

Run any nx generate

Lib

nx generate @nx/<any> \
--preset=ts --directory=/packages/$name \
--publishable \
--importPath=@gvil/$name \
--tags=scope:gvil,type:lib

App

nx generate @nx/<any> \
--preset=ts --directory=/packages/$name \
--publishable \
--importPath=@gvil/$name \
--tags=scope:gvil,type:app

Publish

Run "nx publish" to build all workspace Run nx publish ts to build the specific package.