From 8c315a8126fa0b5865bd219771733eec09f9e12e Mon Sep 17 00:00:00 2001 From: Your Name Date: Wed, 1 Apr 2026 14:40:36 +0530 Subject: [PATCH] docs: update README with usage example and nginx config detail --- README.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 46 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e75b513..56c2d83 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ Stopping and restarting the application preserves all task data thanks to this v - **Port:** 80 (host) -> 80 (container) - **Role:** Serves static HTML/CSS/JS files and reverse-proxies `/api/*` requests to the Flask backend - **Restart policy:** `unless-stopped` -- **Configuration:** Custom `nginx.conf` with `proxy_pass` directive for API routing +- **Configuration:** Custom `nginx.conf` with `proxy_pass` directive for API routing and `large_client_header_buffers 4 32k` for handling large cookies ### 2. taskapp-flask (Backend) @@ -184,6 +184,51 @@ docker compose down -v --rmi all └── README.md # This file ``` +## Example of Working with the Application + +```bash +# Prepare everything needed for the application +./prepare-app.sh +# Output: +# Preparing app... +# Building backend image... +# Building frontend image... +# Creating network... +# Creating volume... +# App prepared successfully. + +# Start the application +./start-app.sh +# Output: +# Starting app... +# Starting database... +# Starting backend... +# Starting frontend... +# +# App is running! +# The app is available at http://localhost:80 + +# Open web browser and work with the application at http://localhost:80 +# - Add tasks using the input field +# - Mark tasks as completed by clicking the checkbox +# - Delete tasks by clicking the X button + +# Stop the application (data is preserved) +./stop-app.sh +# Output: +# Stopping app... +# App stopped. + +# Start again - all tasks are still there +./start-app.sh + +# Remove everything related to the application +./remove-app.sh +# Output: +# Removing app... +# App removed. +``` + ## Sources - [Docker Documentation](https://docs.docker.com/)