ryanmwangi/progyssey
1
0
Fork 0
Code Issues Pull requests Releases Activity

docs(readme): update project structure, add Listmonk configuration details, and edit docker compose up command

Browse source
This commit is contained in:
ryan 2025-06-09 17:41:21 +03:00
parent ffae0780e9
commit ba9f49c162
1 changed files with 21 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -14,15 +14,20 @@ Welcome to the Progyssey Traineeship Program! This project serves as the web app
``` ```
/Progodyssey /Progodyssey
├── /public ├── /public
│ ├── /images # Images directory
│ ├── index.html # Main landing page │ ├── index.html # Main landing page
│ ├── styles.css # Stylesheet for the landing page │ ├── styles.css # Stylesheet for the landing page
│ ├── index.js # JavaScript for client-side interactions │ ├── index.js # JavaScript for client-side interactions
├── /src ├── /src
│ ├── envValidator.js # Validates environment variables
│ ├── formHandler.js # Handles form submission to Listmonk │ ├── formHandler.js # Handles form submission to Listmonk
│ └── routes.js # Contains route definitions │ ├── routes.js # Contains route definitions
│ └── server.js # Main server setup
├── .env # Environment variables for configuration ├── .env # Environment variables for configuration
├── .gitignore # Git ignore file ├── .gitignore # Git ignore file
├── server.js # Main server setup ├── .dockerignore # Docker ignore file
├── .gitattributes # Git attributes file
├── Dockerfile # Docker build instructions
├── package.json # Node.js project configuration ├── package.json # Node.js project configuration
├── README.md # Project documentation ├── README.md # Project documentation
@ -60,6 +65,12 @@ LISTMONK_URL=https://your-listmonk-instance.com/api/subscribers
LISTMONK_USERNAME=listmonk-username LISTMONK_USERNAME=listmonk-username
LISTMONK_PASSWORD=listmonk-password LISTMONK_PASSWORD=listmonk-password
LIST_ID=listmonk-listid 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 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: If you prefer to use Docker Compose, ensure you have a `docker-compose.yml` file in your project directory. Then, run:
```bash ```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. This will automatically build and start the container based on the configuration in the `docker-compose.yml` file.