doc: postgres installation required for local test

radicalbit · Jul 1, 2024 · 7454694 · 7454694
1 parent 80c3588
commit 7454694
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/api/README.md b/api/README.md
@@ -33,6 +33,18 @@ to check.
 
 ## Test
 
+Please install a PostgreSQL database locally. For example, on a macOS platform, execute:
+
+```bash
+brew install postgresql
+```
+
+Note: If any errors occur during pytest runs, please stop the local database service by executing:
+
+```bash
+brew services stop postgresql
+```
+
 Tests are done with `pytest`
 
 Run