* Added mention of the load-tester package to the main readme.

* Added readme page to load-tester package.

Packages/load-tester/K6Tests/@Shared/General.js

@@ -1,10 +1,5 @@
 import {randomString, randomIntBetween} from "https://jslib.k6.io/k6-utils/1.2.0/index.js";
 
-// To run these k6 scripts:
-// 1) Install k6: https://grafana.com/docs/k6/latest/set-up/install-k6
-// 2) Open terminal to the "K6Tests" folder
-// 3) Run this command: `k6 run SCRIPT_FILENAME.js`
-
 export const url = `http://localhost:5100/app-server/graphql`;
 export const jwt = open("../../../../.env").split("\n").find(a=>a.includes("DM_USER_JWT_DEV")).split("=")[1].trim();
 

Packages/load-tester/README.md

@@ -0,0 +1,9 @@
+# Load Tester
+
+Prerequisites:
+* Have an instance of debate-map running in your local Kubernetes cluster.
+* Install k6: https://grafana.com/docs/k6/latest/set-up/install-k6
+
+Running a test:
+* 1\) Open terminal to the "K6Tests" folder
+* 2\) Run this command: `k6 run SCRIPT_FILENAME.js`

README.md

@@ -53,6 +53,7 @@ Development of Debate Map is partially supported by [The Society Library](https:
 * [monitor-backend](https://github.com/debate-map/app/tree/main/Packages/monitor-backend): Backend code for `debatemap.app/monitor`, which is meant for admin-related functionality, and has several unique design goals (see [here](https://github.com/debate-map/app/tree/main/Packages/monitor-backend#design-goals)). \[Rust]
 * [js-common](https://github.com/debate-map/app/tree/main/Packages/js-common): Code shared between JS packages in repo, mainly holding the JS versions of the DB data-structures. \[TypeScript]
 * [web-vcore](https://github.com/debate-map/app/tree/main/Packages/web-vcore): Some common frontend code; shared between various packages. (both in and out of repo) \[TypeScript]
+* [load-tester](https://github.com/debate-map/app/tree/main/Packages/load-tester): Load/stress testing scripts, to run with k6 on a local DM cluster/instance.
 * [deploy](https://github.com/debate-map/app/tree/main/Packages/deploy): Miscellaneous scripts and such, used in the deployment process.
 * [rust-shared](https://github.com/debate-map/app/tree/main/Packages/rust-shared): Code shared between the various Rust packages. \[Rust]
 * [rust-macros](https://github.com/debate-map/app/tree/main/Packages/rust-macros): Procedural macros used by other Rust packages. (proc-macros can't be used from the crate they're defined in) \[Rust]