From 0f2750962f1b861296747e04fb2ff6ffe6f6f777 Mon Sep 17 00:00:00 2001 From: markkovari Date: Sat, 7 Sep 2024 09:33:26 +0200 Subject: [PATCH 1/2] chore: add dotenv file to store secrets --- .env.sample | 2 ++ .gitignore | 1 + README.md | 13 +++++++++++++ 3 files changed, 16 insertions(+) create mode 100644 .env.sample diff --git a/.env.sample b/.env.sample new file mode 100644 index 00000000..21df91ba --- /dev/null +++ b/.env.sample @@ -0,0 +1,2 @@ +MAIL_PASSWORD= +MAIL_USERNAME= \ No newline at end of file diff --git a/.gitignore b/.gitignore index f13774e4..28ebe5ea 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ data *.idea .DS_Store +.env \ No newline at end of file diff --git a/README.md b/README.md index c655d596..a7809a97 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,16 @@ You can find the frontend of the project in the `frontend` folder [here](./frontend/README.md). + + +## Environemnts and secrets + +The project uses a `.env` file to store the secrets and environment variables. You can find an example of the file in the `.env.example` file. The dotenv file is used to store the secrets and environment variables for the docker-compose file. + +You can copy the sample file to a new file called `.env` and fill in the values. + +```bash +cp .env.example .env +``` + +then fill in the values in the `.env` file. From 6ad9ba90bd942d0dcb435e1f963c1d348246725a Mon Sep 17 00:00:00 2001 From: AnnaUgrai <149159395+AnnaUgrai@users.noreply.github.com> Date: Sat, 7 Sep 2024 12:36:13 +0200 Subject: [PATCH 2/2] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Márk Kővári --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a7809a97..00802f87 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ The project uses a `.env` file to store the secrets and environment variables. Y You can copy the sample file to a new file called `.env` and fill in the values. ```bash -cp .env.example .env +cp .env.sample .env ``` then fill in the values in the `.env` file.