Project schema

types/project/Project.md

@@ -0,0 +1,76 @@
+# Project
+
+A `Project` with `metadata`, `editors`, and `tasks`.
+
+This standard is in DRAFT mode. It may be heavily changed in the future.
+
+## Schema
+
+| Key | Type  | Description |
+|----------------|------------------------------------------|----------------------------------------------------------------|
+| `metadata` | [Metadata](../common/Metadata.md) | information describing a project |
+| **`editors`** | [Account List](../common/AccountList.md) | list of accounts that control a project |
+| **`tasks`** | [Tasks](Tasks.md) | list of specific tasks (with rewards) |
+
+## Example
+
+```json
+{
+  "metadata": {
+    "name": "Near Social",
+    "image": {
+      "ipfs_cid": "bafkreid55mbassw335wezjk3gc5rzizwrqpenfxk3dyyljumxvezplhjg4"
+    },
+    "linktree": {
+      "twitter": "NearSocial_",
+      "github": "NearSocial",
+      "telegram": "NearSocial",
+      "website": "near.social"
+    },
+    "description": "Near Social is ...",
+    "backgroundImage": {
+      "ipfs_cid": "bafybeigwqqx2eccpyip66bn2bn6janvss2snv3xuuus3ltin6i46mfkyam"
+    },
+    "tags": {
+      "project": "",
+      "near-social": "",
+      "open-source": ""
+    }
+  },
+  "editors": {
+    "root.near": "",
+    "mob.near": "",
+    "infinity.near": ""
+  },
+  "tasks": {
+    "task_1": {
+        "metadata": {
+            "name": "Task 1",
+            "description": "Create ABC",
+            "tags": {
+                "design": "",
+                "art": "",
+                "community": ""
+            }
+        },
+        "token": "token.paras.near",
+        "amount": "359",
+        "worker": "create.near"
+    },
+    "task_2": {
+        "metadata": {
+            "name": "Task 2",
+            "description": "Create XYZ",
+            "tags": {
+                "dev": "",
+                "product": "",
+                "javascript": ""
+            }
+        },
+        "token": "meta-token.near",
+        "amount": "888",
+        "worker": "devs.near"
+    }
+  }
+}
+```

types/project/Projects.md

@@ -0,0 +1,76 @@
+# Projects
+
+`Projects` with `metadata`, `editors`, and `tasks`.
+
+This standard is in DRAFT mode. It may be heavily changed in the future.
+
+## Schema
+
+| Key | Type | Description |
+|---------------------|----------------------|-----------------------------------------------------------------------|
+| `[project_name]` | [Project](./Project.md) | key is the name of a project, for example: `near_social` |
+
+## Example
+
+```json
+{
+  "near_social": {
+    "metadata": {
+        "name": "Near Social",
+        "image": {
+            "ipfs_cid": "bafkreid55mbassw335wezjk3gc5rzizwrqpenfxk3dyyljumxvezplhjg4"
+        },
+        "linktree": {
+            "twitter": "NearSocial_",
+            "github": "NearSocial",
+            "telegram": "NearSocial",
+            "website": "near.social"
+        },
+        "description": "Near Social is ...",
+        "backgroundImage": {
+            "ipfs_cid": "bafybeigwqqx2eccpyip66bn2bn6janvss2snv3xuuus3ltin6i46mfkyam"
+        },
+        "tags": {
+            "project": "",
+            "near-social": "",
+            "open-source": ""
+        }
+    },
+    "editors": {
+        "root.near": "",
+        "mob.near": "",
+        "infinity.near": ""
+    },
+    "tasks": {
+        "task_1": {
+            "metadata": {
+                "name": "Task 1",
+                "description": "Create ABC",
+                "tags": {
+                    "design": "",
+                    "art": "",
+                    "community": ""
+                }
+            },
+            "token": "token.paras.near",
+            "amount": "359",
+            "worker": "create.near"
+        },
+        "task_2": {
+            "metadata": {
+                "name": "Task 2",
+                "description": "Create XYZ",
+                "tags": {
+                    "dev": "",
+                    "product": "",
+                    "javascript": ""
+                }
+            },
+            "token": "meta-token.near",
+            "amount": "888",
+            "worker": "devs.near",
+        }
+    }
+  }
+}
+```

types/project/Task.md

@@ -0,0 +1,33 @@
+# Task
+
+A `Task` is work that needs to be done for a `Project`.
+
+This standard is in DRAFT mode. It may be heavily changed in the future.
+
+## Schema
+
+| Key | Type | Description |
+|---------------------|----------------------|-----------------------------------------------------------------------|
+| `metadata` | [Metadata](../common/Metadata.md) | info describing a task |
+| `token` | String | key is the ID of a token used as reward for the task |
+| `amount` | String | key is the amount of tokens paid to the worker |
+| `worker` | String | key is the account ID of someone who claims the task |
+
+## Example
+
+```json
+{
+    "metadata": {
+        "name": "TODO",
+        "description": "Create ...",
+        "tags": {
+          "design": "",
+          "art": "",
+          "community": ""
+        }
+    },
+    "token": "meta-token.near",
+    "amount": "888",
+    "worker": "devs.near"
+}
+```

types/project/Tasks.md

@@ -0,0 +1,32 @@
+# Tasks
+
+`Tasks` with metadata, token rewards, and a worker.
+
+This standard is in DRAFT mode. It may be heavily changed in the future.
+
+## Schema
+
+| Key | Type | Description |
+|---------------------|----------------------|-----------------------------------------------------------------------|
+| `[task_id]` | [Task](./Task.md) | key is the ID / name of a task |
+
+## Example
+
+```json
+{
+  "example_task": {
+    "metadata": {
+        "name": "TODO",
+        "description": "Create ...",
+        "tags": {
+          "design": "",
+          "art": "",
+          "community": ""
+        }
+    },
+    "token": "meta-token.near",
+    "amount": "888",
+    "worker": "devs.near"
+  }
+}
+```