docs: update README with usage example and nginx config detail
This commit is contained in:
parent
8dc74a1062
commit
8c315a8126
47
README.md
47
README.md
@ -60,7 +60,7 @@ Stopping and restarting the application preserves all task data thanks to this v
|
|||||||
- **Port:** 80 (host) -> 80 (container)
|
- **Port:** 80 (host) -> 80 (container)
|
||||||
- **Role:** Serves static HTML/CSS/JS files and reverse-proxies `/api/*` requests to the Flask backend
|
- **Role:** Serves static HTML/CSS/JS files and reverse-proxies `/api/*` requests to the Flask backend
|
||||||
- **Restart policy:** `unless-stopped`
|
- **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)
|
### 2. taskapp-flask (Backend)
|
||||||
|
|
||||||
@ -184,6 +184,51 @@ docker compose down -v --rmi all
|
|||||||
└── README.md # This file
|
└── 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
|
## Sources
|
||||||
|
|
||||||
- [Docker Documentation](https://docs.docker.com/)
|
- [Docker Documentation](https://docs.docker.com/)
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user