feat: add Docker examples and setup documentation by lemonte · Pull Request #14 · Universal-Commerce-Protocol/samples

lemonte · 2026-01-13T13:17:05Z

Description

This PR adds comprehensive Docker support for running UCP reference servers, making it easier for developers to get started without installing Node.js, Python, or their dependencies locally.

Changes include:

New Docker setup (docker/):
- docker-compose.nodejs.yml - Standalone Node.js server setup
- docker-compose.python.yml - Standalone Python server setup
- Dockerfiles for both Node.js and Python servers with proper configuration
- Comprehensive README with usage instructions, troubleshooting, and examples
Documentation updates:
- Updated main samples/README.md with Docker section
- Added Docker instructions to nodejs/README.md
- Added Docker instructions to python/server/README.md

Benefits:

Quick start without local dependencies (Node.js, Python, npm, uv, etc.)
Consistent development environment across different machines
Easy testing and experimentation
Production-ready container configurations with health checks
Separate compose files for individual services or combined setup

Type of change

New feature (non-breaking change which adds functionality)
Documentation update

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have tested that the Docker setup works correctly (both servers start and respond to requests)

Pull Request Title

feat: add Docker examples and setup documentation

rest/docker/README.md

docker/README.md

rest/docker/docker-compose.yml

damaz91 · 2026-01-14T08:52:16Z

Thank you for this contribution! Please take action on the comments. We are evaluating the changes and will provide a formal response within 1-2 weeks.

docker/docker-compose.python.yml

rest/docker/docker-compose.yml

docker/nodejs/.dockerignore

rest/docker/docker-compose.python.yml

rest/docker/docker-compose.nodejs.yml

- Introduced separate Docker Compose files for Node.js and Python servers. - Updated README.md to reflect new Docker setup documentation. - Removed the old combined Docker Compose file. - Added .dockerignore files for both Node.js and Python to exclude unnecessary files. - Created Dockerfiles for both servers to streamline the build process.

- Added '*.md' to the .dockerignore file for the Python Docker setup to prevent markdown files from being included in the Docker context.

docker/README.md

- Corrected the Dockerfile paths in `docker-compose.nodejs.yml` and `docker-compose.python.yml`. - Updated the README files for both Node.js and Python servers to improve clarity and organization of setup instructions. - Removed outdated sections from the README files to streamline the documentation.

docker/nodejs/docker-compose.yml

docker/python/docker-compose.yml

- Moved Docker Compose files for Node.js and Python servers into their respective directories. - Updated README files to reflect new paths and simplify usage instructions. - Added new Docker Compose files for both Node.js and Python servers to enhance clarity and organization.

docker/python/docker-compose.yml

- Modified .dockerignore to include markdown files. - Updated docker-compose.yml to change build context and Dockerfile path. - Adjusted Dockerfile to copy package files and source from the new directory structure.

feat: add Docker examples and setup documentation

ff07d06

lemonte requested a review from a team January 13, 2026 13:17

lemonte mentioned this pull request Jan 13, 2026

docs: add Docker examples mention in getting started Universal-Commerce-Protocol/ucp#34

Open

5 tasks

Merge branch 'main' into feat/add-docker-examples

b2c29f6