Skip to content

Open Source Wealth Management Software. Angular + NestJS + Prisma + Nx + TypeScript 🤍

Feature/rename example env file (#1734)

Thomas Kaulb81377a6824a
diff --git a/.env b/.env.example
similarity index 100%
rename from .env
rename to .env.example
diff --git a/.gitignore b/.gitignore
index 7440c445ac..307d7e9e2d 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 13220027ba..9f9c868a3e 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 1c319db548..77ae7344cf 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 239e053ae3..f0468c2090 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",