Skip to content

Commit fdc87c8

Browse files
committed
docs(api): simplify and clarify environment setup in README
Updates the "Configuration" section in the README.md to be clearer and more direct. Instead of instructing users to create a .env file from scratch and duplicating the example content, it now instructs them to copy the existing `.env.example` file. This removes redundancy and improves the developer setup experience.
1 parent 59297c5 commit fdc87c8

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

README.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -75,20 +75,15 @@ for more details.
7575
* Dart Frog CLI (`dart pub global activate dart_frog_cli`)
7676

7777
2. **Configuration:**
78-
Before running the server, you must configure the database connection by
79-
setting the `DATABASE_URL` environment variable.
80-
81-
Create a `.env` file in the root of the project or export the variable in
82-
your shell:
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"
78+
Before running the server, you must configure the necessary environment
79+
variables.
80+
81+
Copy the `.env.example` file to a new file named `.env`:
82+
```bash
83+
cp .env.example .env
9184
```
85+
Then, open the new `.env` file and update the variables with your actual
86+
configuration values, such as the `DATABASE_URL`.
9287

9388
3. **Clone the repository:**
9489
```bash

0 commit comments

Comments
 (0)