From b81377a6824a124dfb9a032fca28acd657fc8d07 Mon Sep 17 00:00:00 2001
From: Thomas Kaul <4159106+dtslvr@users.noreply.github.com>
Date: Sat, 25 Feb 2023 11:20:38 +0100
Subject: [PATCH] Feature/rename example env file (#1734)

* Rename .env to .env.example

* Ignore .env file

* Update changelog
---
 .env => .env.example | 0
 .gitignore           | 3 ++-
 CHANGELOG.md         | 5 +++++
 README.md            | 6 ++++--
 package.json         | 2 +-
 5 files changed, 12 insertions(+), 4 deletions(-)
 rename .env => .env.example (100%)

diff --git a/.env b/.env.example
similarity index 100%
rename from .env
rename to .env.example
diff --git a/.gitignore b/.gitignore
index 7440c445a..307d7e9e2 100644
--- a/.gitignore
+++ b/.gitignore
@@ -25,6 +25,7 @@
 
 # misc
 /.angular/cache
+.env
 .env.prod
 /.sass-cache
 /connect.lock
@@ -38,4 +39,4 @@ yarn-error.log
 
 # System Files
 .DS_Store
-Thumbs.db
\ No newline at end of file
+Thumbs.db
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 13220027b..9f9c868a3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Renamed the example environment variable file from `.env` to `.env.example`
 - Upgraded `zone.js` from version `0.11.8` to `0.12.0`
 
 ### Fixed
@@ -24,6 +25,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed `RangeError: Maximum call stack size exceeded` for values of type `Big` in the value redaction interceptor for the impersonation mode
 - Reset the letter spacing in buttons
 
+### Todo
+
+- Ensure that you still have a `.env` file in your project
+
 ## 1.237.0 - 2023-02-19
 
 ### Added
diff --git a/README.md b/README.md
index 1c319db54..77ae7344c 100644
--- a/README.md
+++ b/README.md
@@ -106,7 +106,8 @@ We provide official container images hosted on [Docker Hub](https://hub.docker.c
 
 - Basic knowledge of Docker
 - Installation of [Docker](https://www.docker.com/products/docker-desktop)
-- Local copy of this Git repository (clone)
+- Create a local copy of this Git repository (clone)
+- Copy the file `.env.example` to `.env` and populate it with your data (`cp .env.example .env`)
 
 #### a. Run environment
 
@@ -150,7 +151,8 @@ Please follow the instructions of the Ghostfolio [Unraid Community App](https://
 - [Docker](https://www.docker.com/products/docker-desktop)
 - [Node.js](https://nodejs.org/en/download) (version 16)
 - [Yarn](https://yarnpkg.com/en/docs/install)
-- A local copy of this Git repository (clone)
+- Create a local copy of this Git repository (clone)
+- Copy the file `.env.example` to `.env` and populate it with your data (`cp .env.example .env`)
 
 ### Setup
 
diff --git a/package.json b/package.json
index 239e053ae..f0468c209 100644
--- a/package.json
+++ b/package.json
@@ -44,7 +44,7 @@
     "start:prod": "yarn database:migrate && yarn database:seed && node main",
     "start:server": "nx run api:serve --watch",
     "start:storybook": "nx run ui:storybook",
-    "test": "nx test",
+    "test": "npx dotenv-cli -e .env.example -- nx test",
     "test:single": "nx test --test-file portfolio-calculator-novn-buy-and-sell.spec.ts",
     "ts-node": "ts-node",
     "update": "nx migrate latest",