Skip to content

Commit

Permalink
chore: partially revert previous changes as notes doesn't work inside…
Browse files Browse the repository at this point in the history
… <details>

Correction for ea65af9 commit.

[skip ci]
  • Loading branch information
php-coder committed May 4, 2024
1 parent ea65af9 commit 6233971
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,20 @@ Generates the endpoints (or a whole app) from a mapping (SQL query -> URL)
| Golang | <pre>$ export DB_NAME=my-db DB_USER=my-user DB_PASSWORD=my-password<br/>$ go run *.go</pre>or<pre>$ go build -o app<br/>$ ./app</pre> |
| Python | <pre>$ pip install -r requirements.txt<br/>$ export DB_NAME=my-db DB_USER=my-user DB_PASSWORD=my-password<br/>$ uvicorn app:app --port 3000</pre> |
> [!TIP]
> While the example used `export` for setting up the environment variables, we don't recommend export variables that way! This was provided as an example to illustrate that an application follows [The Twelve Factors](https://12factor.net/config) and can be configured by passing environment variables. In real life, you will use docker, docker-compose, Kubernetes or other ways to run an app with required environment variables.
---
:bulb: **NOTE**
> [!NOTE]
> An app also supports other environment variables:
>
> * `PORT`: a port to listen (defaults to `3000`)
> * `DB_HOST` a database host (defaults to `localhost`)
While the example used `export` for setting up the environment variables, we don't recommend export variables that way! This was provided as an example to illustrate that an application follows [The Twelve Factors](https://12factor.net/config) and can be configured by passing environment variables. In real life, you will use docker, docker-compose, Kubernetes or other ways to run an app with required environment variables.
---
:bulb: **NOTE**
An app also supports other environment variables:
* `PORT`: a port to listen (defaults to `3000`)
* `DB_HOST` a database host (defaults to `localhost`)
---
</details>

1. Test that it works
Expand Down

0 comments on commit 6233971

Please sign in to comment.