Skip to content

Commit 5f43537

Browse files
committed
docs(api): improve clarity of .env.example comments
Updates the comments in the `.env.example` file to be more explicit and unambiguous. The new comments clearly state when each variable is required (e.g., "REQUIRED" vs. "REQUIRED FOR PRODUCTION") and provide better context for their purpose. This resolves confusion around the previous "Optional for Production" wording.
1 parent 1a58ecd commit 5f43537

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

.env.example

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22
# Copy this file to .env and fill in your actual configuration values.
33
# The .env file is ignored by Git and should NOT be committed.
44

5+
# REQUIRED: The full connection string for your MongoDB instance.
6+
# The application cannot start without a database connection.
57
# DATABASE_URL="mongodb://user:password@localhost:27017/ht_api_db"
68

7-
# (Optional for Production) The specific origin URL of your web client (e.g., the HT Dashboard).
8-
# This is required for production deployments to allow cross-origin requests.
9+
# REQUIRED FOR PRODUCTION: The specific origin URL of your web client.
10+
# This allows the client (e.g., the HT Dashboard) to make requests to the API.
911
# For local development, this can be left unset as 'localhost' is allowed by default.
1012
# CORS_ALLOWED_ORIGIN="https://your-dashboard.com"

0 commit comments

Comments
 (0)