Merge pull request panates#35 from jacobdr/contributing-docs-and-formatting

Prepare for formatting application + minor docs updates

Author: erayhanoglu

CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Developer Documentation
+
+## Tests
+
+### Run the test suite
+
+1. You must spin up a postgres database on your local machine that allows for trusted (i.e. passwordless) authentication. The database should be running on localhost at port `5432` (the standard postgres port). 
+
+    You may choose to (but not are not required to) use docker for this purpose by running the below.
+
+    ```bash
+    docker compose up
+    # or this to run in the background
+    docker compose up --detach
+    ```
+
+2. Execute the test suite with: `npm test`

docker-compose.yaml

@@ -0,0 +1,15 @@
+services:
+  postgres:
+    image: postgres:16.2-alpine3.19
+    ports:
+      - '5432:5432'
+    volumes:
+      - postgres-data:/var/lib/postgresql/data
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: password
+      POSTGRES_HOST_AUTH_METHOD: 'trust'
+      POSTGRES_DB: postgres
+
+volumes:
+  postgres-data: {}