Skip to content

Commit 1a58ecd

Browse files
committed
docs(api): align README environment example with .env.example
Updates the environment variable example in the README.md to match the format and content of `.env.example`. This change adds comments explaining each variable and comments them out by default, improving clarity and ensuring consistency across project documentation.
1 parent c219903 commit 1a58ecd

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,14 @@ for more details.
8080

8181
Create a `.env` file in the root of the project or export the variable in
8282
your shell:
83-
```
84-
DATABASE_URL="mongodb://user:password@localhost:27017/ht_api_db"
83+
```shell
84+
# The full connection string for your MongoDB instance.
85+
# Required for the application to connect to the database.
86+
# DATABASE_URL="mongodb://user:password@localhost:27017/ht_api_db"
87+
88+
# (Optional for Production) The specific origin URL of your web client.
89+
# This is required for production deployments to allow cross-origin requests.
90+
# CORS_ALLOWED_ORIGIN="https://your-dashboard.com"
8591
```
8692

8793
3. **Clone the repository:**

0 commit comments

Comments
 (0)