Merge pull request #115 from boardroom-inc/chore/add-example-project

chore: add example project

protocols/__example/events.json

@@ -0,0 +1 @@
+[]

protocols/__example/index.json

@@ -0,0 +1,19 @@
+{
+  "cname": "example",
+  "name": "Example",
+  "description": "A concise description of the protocol",
+  "path": "example",
+  "folder": "__example",
+  "type": "snapshot",
+  "suffix": "EXP",
+  "coinGeckoPriceString": "example",
+  "tokenContractAddress": "0x0000000000000000000000000000000000000000",
+  "isEnabled": true,
+  "hasOnchain": false,
+  "isHybrid": false,
+  "hasDelegation": false,
+  "snapshotSpaceName": "example.eth",
+  "invalidSnapshots": [],
+  "discourseForum": {},
+  "safeAddress": "0x0000000000000000000000000000000000000000"
+}

protocols/__example/overview.md

@@ -0,0 +1 @@
+Overview of protocol and governance process.

scripts/build.ts

@@ -3,9 +3,11 @@ import mkdirp from "mkdirp";
 
 const protocols = fs.readdirSync("./protocols");
 
-const protocolInfo = protocols.map((protocol) =>
+const protocolInfo = protocols
-  fs.readFileSync(`./protocols/${protocol}/index.json`, "utf8")
+  .filter((protocol) => protocol !== "__example")
-);
+  .map((protocol) =>
+    fs.readFileSync(`./protocols/${protocol}/index.json`, "utf8")
+  );
 
 mkdirp.sync("./dist");
 fs.copyFileSync("./types.ts", "./dist/types.ts");