From 866dca0e19551107e1d4b24f6a974900dfa01d33 Mon Sep 17 00:00:00 2001 From: Chneemann Date: Tue, 10 Sep 2024 04:54:53 +0200 Subject: [PATCH] Create README.md in the front- and backend folder --- backend/README.md | 18 ++++++++++++++++++ frontend/README.md | 29 +++++------------------------ 2 files changed, 23 insertions(+), 24 deletions(-) create mode 100644 backend/README.md diff --git a/backend/README.md b/backend/README.md new file mode 100644 index 0000000..1a3ce01 --- /dev/null +++ b/backend/README.md @@ -0,0 +1,18 @@ +# Backend + +## Env Configuration + +To set the mail configuration for the backend, you must create an `.env` file in the root directory of your project. This file should have the following content: + +### Step 1: Creating the `.env` file + +Create a file named `.env` in the root directory of the project. + +### Step 2: Add the e-mail configuration + +Open the `.env` file and add the following lines: + +```env +EMAIL_HOST_USER=example@gmail.com +EMAIL_HOST_PASSWORD=password +``` diff --git a/frontend/README.md b/frontend/README.md index 677b5dd..a690fb2 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -15,32 +15,13 @@ You need to create the following files in the `src/environments/` directory: In the `environment.ts` & `environment.prod.ts` file, add the following content: -````typescript +```typescript export const environment = { production: false, - baseUrl: 'YOUR_API_URL_HERE', + baseUrl: "YOUR_API_URL_HERE", // Guest account - guestMail: 'YOUR_GUEST_EMAIL_HERE', - guestPassword: 'YOUR_GUEST_PASSWORD_HERE', + guestMail: "YOUR_GUEST_EMAIL_HERE", + guestPassword: "YOUR_GUEST_PASSWORD_HERE", }; - -# Backend - -## Env Configuration - -To set the mail configuration for the backend, you must create an `.env` file in the root directory of your project. This file should have the following content: - -### Step 1: Creating the `.env` file - -Create a file named `.env` in the root directory of the project. - -### Step 2: Add the e-mail configuration - -Open the `.env` file and add the following lines: - -```env -EMAIL_HOST_USER=example@gmail.com -EMAIL_HOST_PASSWORD=password - -```` +```