add Prerequisite info

ytliuSVN · Nov 2, 2024 · e31caf6 · e31caf6
1 parent 2b0e909
commit e31caf6
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,8 @@
-# recipe-app-api
+# recipe-app-api
+
+## Prerequisite
+
+- A Docker Hub secret is configured in project settings for authentication through GitHub Actions, preventing rate limit issues.
+- Installed the `psycopg2` PostgreSQL adapter and configured the PostgreSQL service, handling the race condition to ensure the database is ready before the application continues.
+- The `docker compose up` command was used to start the server, enabling access to the running Django project.
+<!-- - Architecture Diagram -->