From ba9f49c1627cbc48a9d7e5fd0edea8b0baa72898 Mon Sep 17 00:00:00 2001
From: ryan <ryannganga13325@gmail.com>
Date: Mon, 9 Jun 2025 17:41:21 +0300
Subject: [PATCH] docs(readme): update project structure, add Listmonk
 configuration details, and edit docker compose up command

---
 README.md | 31 +++++++++++++++++++++----------
 1 file changed, 21 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index dff737c..ab46a4c 100644
--- a/README.md
+++ b/README.md
@@ -14,17 +14,22 @@ Welcome to the Progyssey Traineeship Program! This project serves as the web app
 ```
 /Progodyssey
 ├── /public
+│   ├── /images           # Images directory
 │   ├── index.html        # Main landing page
-│   ├── styles.css       # Stylesheet for the landing page
-│   ├── index.js         # JavaScript for client-side interactions
+│   ├── styles.css        # Stylesheet for the landing page
+│   ├── index.js          # JavaScript for client-side interactions
 ├── /src
-│   ├── formHandler.js   # Handles form submission to Listmonk
-│   └── routes.js        # Contains route definitions
-├── .env                 # Environment variables for configuration
-├── .gitignore           # Git ignore file
-├── server.js            # Main server setup
-├── package.json         # Node.js project configuration
-├── README.md            # Project documentation
+│   ├── envValidator.js   # Validates environment variables
+│   ├── formHandler.js    # Handles form submission to Listmonk
+│   ├── routes.js         # Contains route definitions
+│   └── server.js         # Main server setup
+├── .env                  # Environment variables for configuration
+├── .gitignore            # Git ignore file
+├── .dockerignore         # Docker ignore file
+├── .gitattributes        # Git attributes file
+├── Dockerfile            # Docker build instructions
+├── package.json          # Node.js project configuration
+├── README.md             # Project documentation
 
 ```
 
@@ -60,6 +65,12 @@ LISTMONK_URL=https://your-listmonk-instance.com/api/subscribers
 LISTMONK_USERNAME=listmonk-username
 LISTMONK_PASSWORD=listmonk-password
 LIST_ID=listmonk-listid
+LISTMONK_BASE_URL=https://your-listmonk-instance.com/api
+PRESET_CAMPAIGN_ID=1                # Example: 1 (numeric ID of your welcome campaign/template in Listmonk)
+TEMPLATE_ID_WEEK_1=101              # Example: 101 (numeric ID of week 1 email template)
+TEMPLATE_ID_WEEK_2=102              # Example: 102 (numeric ID of week 2 email template)
+TEMPLATE_ID_WEEK_3=103              # Example: 103 (numeric ID of week 3 email template)
+TEMPLATE_ID_WEEK_4=104              # Example: 104 (numeric ID of week 4 email template)
 PORT=3002
 ```
 
@@ -104,7 +115,7 @@ This maps the container's port `3002` to the host system's port `3002` and uses
 If you prefer to use Docker Compose, ensure you have a `docker-compose.yml` file in your project directory. Then, run:
 
 ```bash
-docker-compose up -d
+docker compose up -d
 ```
 
 This will automatically build and start the container based on the configuration in the `docker-compose.yml` file.