Open Source Wealth Management Software. Angular + NestJS + Prisma + Nx + TypeScript 🤍
TypeScript angularetffinancefintechghostfoliohacktoberfestinvestingnestjsosspersonal-financeportfolioprismasoftwarestocktrackertradingtypescriptwealth-managementweb
Add descriptions (#1113)
Thomas Kaul44058b2d7a8b
diff --git a/README.md b/README.mdindex 9ae4b1e825..a5a98078c3 100644--- a/README.md+++ b/README.md@@ -83,20 +83,20 @@ The frontend is built with [Angular](https://angular.io) and uses [Angular Mater### Supported Environment Variables-| Name | Default Value | Description |-| ------------------- | ------------- | ----------- |-| `ACCESS_TOKEN_SALT` | | |-| `BASE_CURRENCY` | `USD` | |-| `DATABASE_URL` | | |-| `HOST` | `0.0.0.0` | |-| `JWT_SECRET_KEY` | | |-| `PORT` | `3333` | |-| `POSTGRES_DB` | | |-| `POSTGRES_PASSWORD` | | |-| `POSTGRES_USER` | | |-| `REDIS_HOST` | `localhost` | |-| `REDIS_PASSWORD` | | |-| `REDIS_PORT` | `6379` | |+| Name | Default Value | Description |+| ------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------- |+| `ACCESS_TOKEN_SALT` | | A random string used as salt for access tokens |+| `BASE_CURRENCY` | `USD` | The base currency of the Ghostfolio application. Caution: This cannot be changed later! |+| `DATABASE_URL` | | The database connection URL, e.g. `postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@localhost:5432/${POSTGRES_DB}?sslmode=prefer` |+| `HOST` | `0.0.0.0` | The host where the Ghostfolio application will run on |+| `JWT_SECRET_KEY` | | A random string used for _JSON Web Tokens_ (JWT) |+| `PORT` | `3333` | The port where the Ghostfolio application will run on |+| `POSTGRES_DB` | | The name of the _PostgreSQL_ database |+| `POSTGRES_PASSWORD` | | The password of the _PostgreSQL_ database |+| `POSTGRES_USER` | | The user of the _PostgreSQL_ database |+| `REDIS_HOST` | `localhost` | The host where _Redis_ is running |+| `REDIS_PASSWORD` | | The password of _Redis_ |+| `REDIS_PORT` | `6379` | The port where _Redis_ is running |### Run with Docker Compose