contributing

Author: contact-mailslurp

.build.py

@@ -0,0 +1,25 @@
+# create a json description of all the projects with links and names
+# frontend will embed the json and display on the docs page
+
+import os
+import json
+
+
+# covert example directory into a line item
+def example_item(path):
+    return {"name": path.replace("-", " ").title(), "url": github + path, "directory": path}
+
+
+# get a list of directories in the example project
+manifest_path = os.environ["MANIFEST_PATH"]
+github = "https://www.github.com/mailslurp/examples/tree/master/"
+directories = next(os.walk(os.environ["ROOT"]))[1]
+directories = [path for path in directories if "." not in path]
+
+# map each directory and save the json
+links = list(map(example_item, directories))
+json_object = json.dumps({"links": links}, indent=2)
+with open(manifest_path, 'w+') as output_file:
+    output_file.write(json_object)
+
+print(f'Build complete. {manifest_path} file written')

.build/build-manifest.py

@@ -0,0 +1,8 @@
+# Contributing
+This repository contains examples projects for MailSlurp. 
+
+## Testing
+Hosted on Github the project uses many actions inside .github folder to run tests in each example directory.
+Each action typically sets an API_KEY env variable and runs `make test`.
+
+## Server

CONTRIBUTING.md

@@ -1,5 +1,7 @@
-build:
-	python3 .build.py
+build: build-manifest
+
+build-manifest:
+	ROOT=$(PWD) MANIFEST_PATH=$(PWD)/.manifest.json python3 .build/build-manifest.py
 
 ci-env:
 	echo "API_KEY=$$API_KEY" > .env