Dev environment

Author: MykolaBilyi

.devcontainer/Dockerfile

@@ -1,28 +1,15 @@
 {
   "name": "xmpp-llm-bridge",
-  "dockerComposeFile": "docker-compose.yml",
-  "service": "app",
+  "image": "mcr.microsoft.com/devcontainers/go:1-1.23-bookworm",
   "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
   "forwardPorts": [
-    // "db:5432",
     8080
   ],
   "containerEnv": {
     "ENV": "dev"
   },
-  // "postCreateCommand": "go mod tidy",
-  "features": {
-    "ghcr.io/devcontainers/features/common-utils:2": {
-      "installZsh": "true",
-      "username": "vscode",
-      "userUid": "1000",
-      "userGid": "1000",
-      "upgradePackages": "true"
-    },
-    "ghcr.io/devcontainers/features/go:1": {
-      "version": "none"
-    }
-  },
+  "postCreateCommand": "cd ${containerWorkspaceFolder}; /usr/bin/env sh .devcontainer/postCreateCommand.sh",
+  "features": {},
   "customizations": {
     "vscode": {
       "settings": {
@@ -36,6 +23,5 @@
       ]
     }
   },
-  // Set `remoteUser` to `root` to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
   "remoteUser": "vscode"
 }

.devcontainer/devcontainer.json

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+
+echo "[ ! -f ${PWD}/.env ] || export \$(grep -v '^#' ${PWD}/.env | xargs)" >>/home/vscode/.bashrc
+go install github.com/joerdav/xc/cmd/xc@latest && xc -complete
+go mod tidy

.devcontainer/docker-compose.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 4

.devcontainer/postCreateCommand.sh

@@ -0,0 +1,54 @@
+# Changelog
+<!-- markdownlint-configure-file { "MD024": { "siblings_only": true } } -->
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.2] - 2025-08-29
+
+### Added
+
+- Added project description in README.md
+- Added CHANGELOG.md file
+- devcontainer config
+- Dependabot config
+
+## [0.1.1] - 2025-08-19
+
+### Changed
+
+- Major refactoring of project structure to implement hexagonal architecture
+  - Moved from `api/` structure to `internal/app/`, `internal/ports/`, and `internal/adapters/` pattern
+  - Relocated handlers from `api/client/handlers/` to `internal/app/client/handlers/`
+  - Moved server components from `api/server/` to `internal/app/server/`
+  - Restructured main application logic into `internal/app/app.go` with proper dependency injection
+  - Enhanced XMPP handling with new `pkg/xmpp/` utilities and message multiplexing
+  - Improved configuration structure and expanded default configuration options
+  - Added new port interfaces for better abstraction (`xmppSession.go`)
+  - Refined entity models and adapter implementations for better separation of concerns
+
+## [0.1.0] - 2025-08-19
+
+### Added
+
+- Initial release of XMPP-LLM Bridge service
+- XMPP client implementation with SASL authentication using mellium.im/xmpp
+- OpenAI LLM integration for processing chat messages
+- Basic XMPP message handlers:
+  - Debug handler for logging incoming stanzas
+  - Echo message handler for testing
+  - LLM message handler for AI-powered responses
+- Configuration management with YAML config files and environment variable overrides
+- Support for loading secrets from files using `_FILE` suffix environment variables
+- Docker containerization with multi-stage builds
+- HTTP server with health check endpoint on port 8080
+- Development container configuration with VS Code devcontainer
+- Basic project structure with hexagonal architecture foundations
+- GitHub Actions workflow for automated release builds and Docker image publishing
+
+[unreleased]: https://github.com/MykolaBilyi/xmpp-llm-bridge/compare/v0.1.2...HEAD
+[0.1.2]: https://github.com/MykolaBilyi/xmpp-llm-bridge/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/MykolaBilyi/xmpp-llm-bridge/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/MykolaBilyi/xmpp-llm-bridge/releases/tag/v0.1.0

.github/dependabot.yml

@@ -1,33 +1,102 @@
 # XMPP LLM Bridge
 
+[![GitHub Release](https://img.shields.io/github/v/release/mykolabilyi/xmpp-llm-bridge)](https://github.com/mykolabilyi/xmpp-llm-bridge/releases) [![xc compatible](https://xcfile.dev/badge.svg)](https://xcfile.dev)
+
+## Description
+
+XMPP LLM Bridge is a Go service that connects XMPP chat networks with OpenAI's Large Language Models, enabling AI-powered conversations through XMPP clients. The service acts as an intelligent bot that can participate in XMPP conversations by processing incoming messages through OpenAI's API and responding with contextually relevant replies.
+
+### Key Features
+
+- **XMPP Integration**: Full XMPP client implementation using mellium.im/xmpp library with SASL authentication
+- **OpenAI LLM Integration**: Seamlessly forwards chat messages to OpenAI's API and returns responses
+- **Configurable**: YAML-based configuration with environment variable overrides
+- **Docker Ready**: Containerized deployment with multi-stage builds
+
+## Usage
+
+The XMPP LLM Bridge can be deployed in several ways. All methods require three essential environment variables:
+
+- `XMPP_JID`: Your bot's XMPP account (e.g., `bot@example.com`)
+- `XMPP_PASSWORD`: Password for the XMPP account
+- `OPENAI_API_KEY`: Your OpenAI API key
+
+### Quick Start with Docker
+
+Pull and run the latest image:
+
+```bash
+docker run \
+    -e XMPP_JID=bot@example.com \
+    -e XMPP_PASSWORD=your_password \
+    -e OPENAI_API_KEY=sk-your-openai-key \
+    ghcr.io/mykolabilyi/xmpp-llm-bridge:latest
+```
+
+### Docker Compose (Recommended)
+
+Use this `docker-compose.yml`:
+
+```yaml
+services:
+  bridge:
+    image: ghcr.io/mykolabilyi/xmpp-llm-bridge:latest
+    environment:
+      - XMPP_JID=bot@example.com
+      - XMPP_PASSWORD=your_password
+      - OPENAI_API_KEY=sk-your-openai-key
+    restart: unless-stopped
+```
+
+Start the service:
+
+```bash
+docker compose up -d
+```
+
+## Development
+
+### Architecture
+
+The service implements a hexagonal architecture pattern:
+
+- **Core Business Logic**: Located in `/internal/app/` with dependency injection via context-based providers
+- **Ports**: Interfaces in `/internal/ports/` define contracts for external services
+- **Adapters**: External integrations in `/internal/adapters/` handle XMPP, OpenAI, and HTTP communications
+- **Entities**: Domain models in `/internal/entities/` represent core data structures
+
+The application runs two concurrent services:
+
+1. **XMPP Client**: Handles incoming chat messages and processes them through the LLM
+2. **HTTP Server**: Provides health check endpoint on port 8080 for monitoring
+
 ## Tasks
 
+[xc] is recommended to simplify running tasks
+
 ### run
 
 ```sh
 go run cmd/app/main.go
 ```
 
-### build-image
+### image-build
 
 run: once
 Inputs: TAG
 Environment: TAG=dev
 
 ```sh
-docker build -t ghcr.io/mykolabilyi/xmpp-llm-bridge:$TAG .
+docker compose build
 ```
 
-### run-image
+### image-run
 
 Inputs: TAG
 Environment: TAG=dev
-Requires: build-image
 
 ```sh
-docker run --rm --name xmpp-llm-bridge-dev \
-    -e XMPP_JID=$XMPP_JID \
-    -e XMPP_PASSWORD=$XMPP_PASSWORD \
-    -p 8080:8080 \
-    ghcr.io/mykolabilyi/xmpp-llm-bridge:$TAG
+docker compose up
 ```
+
+[xc]: https://xcfile.dev/

CHANGELOG.md

@@ -1,11 +1,14 @@
-version: '3.9'
 services:
   bridge:
+    image: ghcr.io/mykolabilyi/xmpp-llm-bridge:${TAG:-dev}
     build:
       context: .
       dockerfile: Dockerfile
       args:
         DOCKER_BUILDKIT: 1
-        PORT: 8080
+    environment:
+      - XMPP_JID=${XMPP_JID:?}
+      - XMPP_PASSWORD=${XMPP_PASSWORD:?}
+      - OPENAI_API_KEY=${OPENAI_API_KEY:?}
     ports:
       - 8080:8080