git2wp

WordPress Git Publisher 🚀

License: MIT Node.js Version PRs Welcome

Automatically generate and publish WordPress articles based on Git activity using AI (Ollama).

Note: This README is also available in Polish below.

Table of Contents

✨ Features

🚀 Quick Start

  1. Clone the repository 
    git clone https://github.com/your-username/wordpress-git-publisher.git
cd wordpress-git-publisher
  2. Configure environment 
    cp .env.example .env
# Edit .env with your WordPress credentials and other settings
  3. Start with Docker Compose 
    docker compose up -d
  4. Access the web interface 
    http://localhost:9000

Manual Installation

  1. Clone and install dependencies 
    git clone https://github.com/your-username/wordpress-git-publisher.git
cd wordpress-git-publisher
make install
  2. Configure environment 
    cp .env.example .env
# Edit .env with your configuration
  3. Start the application 
    make start

📦 What’s New in v1.1.0

🔧 Usage

Starting Services

  1. Using Docker Compose (Recommended) 
    # Start all services
docker compose up -d

# View logs
docker compose logs -f

# Stop services
docker compose down
  2. Using Make (Manual Installation) 
    # Start all services
make start

# Start frontend only
make frontend

# Start backend only
make backend

Publishing Articles

  1. Configure WordPress Settings
    • Open http://localhost:9000/settings.html
    • Enter your WordPress URL, username, and application password
    • Configure Ollama settings (default URL: http://localhost:11434)
    • Save the configuration
  2. Scan Git Repositories
    • Open http://localhost:9000
    • The app will scan for Git repositories in the github/*/* structure
    • Select a repository from the dropdown
  3. Generate and Publish Articles
    • Choose a date to analyze Git activity
    • Click “Generate” to create an article using AI
    • Preview and edit the content if needed
    • Click “Publish” to post to WordPress
  4. Monitor Status
    • Check frontend health at http://localhost:9000/health
    • Check backend health at http://localhost:3001/api/health
    • View logs in the logs directory
    • Review and click “Publish” to post to WordPress
  5. Via Command Line 
    # Replace YYYY-MM-DD with your target date
make publish date=YYYY-MM-DD

    Example:

    make publish date=2025-06-05

Monitoring

⚙️ Configuration

Environment Variables

Copy .env.example to .env and update the values:

cp .env.example .env
nano .env  # or use your preferred text editor

Required Environment Variables

# Server Configuration
PORT=3001
NODE_ENV=development

# Frontend Configuration
FRONTEND_PORT=8088
API_URL=http://localhost:3001

# WordPress Configuration
WORDPRESS_URL=https://your-wordpress-site.com
WORDPRESS_USERNAME=your_username
WORDPRESS_PASSWORD=your_application_password

# Ollama Configuration
OLLAMA_BASE_URL=http://localhost:11434
DEFAULT_MODEL=mistral:7b

# Git Configuration
GIT_SCAN_DEPTH=3
GIT_PATH=/path/to/your/repositories

# Logging
LOG_LEVEL=debug
LOG_FILE=logs/app.log

🛠️ Requirements

Software

Services

⚙️ Konfiguracja

Plik .env

Skopiuj plik .env.example do .env i zaktualizuj wartości:

cp .env.example .env
nano .env  # lub inny edytor tekstu

Wymagane zmienne środowiskowe

# Server Configuration
PORT=3001
NODE_ENV=development

# Frontend Configuration
FRONTEND_PORT=8088
API_URL=http://localhost:3001

# WordPress Configuration
WORDPRESS_URL=https://twoja-strona.com
WORDPRESS_USERNAME=twoj_uzytkownik
WORDPRESS_PASSWORD=twoje_haslo_lub_application_password

# Ollama Configuration
OLLAMA_BASE_URL=http://localhost:11437
DEFAULT_MODEL=mistral:7b

# Git Configuration
GIT_SCAN_DEPTH=3
GIT_PATH=/sciezka/do/twoich/repozytoriow

# Logging
LOG_LEVEL=debug
LOG_FILE=logs/app.log

🛠️ Wymagania

Oprogramowanie

Usługi

Konfiguracja i generowanie artykułu

📦 Installation

1. Clone the repository

git clone https://github.com/your-username/wordpress-git-publisher.git
cd wordpress-git-publisher

2. Install dependencies

make install
# or
npm install

3. Configure Ollama

Install Ollama

# Linux/macOS
curl -fsSL https://ollama.ai/install.sh | sh

# Or download from https://ollama.ai/download for Windows

# Start Ollama
ollama serve

# Download a model (in a separate terminal)
ollama pull mistral:7b

4. WordPress Configuration

Generate Application Password:

  1. Log in to WordPress Admin
  2. Go to Users → Your Profile
  3. Scroll down to the Application Passwords section
  4. Enter a name for your application (e.g., “Git Publisher”)
  5. Click Add New Application Password
  6. Copy the generated password (it will only be shown once!)

🔧 Usage

Available Commands

# Install dependencies
make install

# Start the application
make start

# Stop the application
make stop

# Restart the application
make restart

# Start in development mode with auto-reload
make dev

# Clean up temporary files
make clean

# Remove node_modules and logs
make distclean

# Show help
make help

Web Interface

  1. WordPress Configuration
    • WordPress URL: https://your-wordpress-site.com
    • Username: Your WordPress username
    • Application Password: The password generated in the WordPress settings
    • Click “Test Connection”
  2. Ollama Configuration
    • Ollama URL: http://localhost:11434 (default)
    • Model: Select an available model (e.g., mistral:7b)
    • Click “Test Ollama”
  3. Git Configuration
    • GitHub Folders Path: /path/to/your/github/repos or C:\Users\username\github
    • Analysis Date: Select a date (defaults to today)
    • Click “Scan Git Projects”
  4. Generate Article
    • Optionally provide a custom title
    • Category: WordPress category name
    • Tags: Comma-separated tags
    • Click “Generate and Publish Article”
  5. Publish
    • Review the generated article in the preview section
    • Click “Publish to WordPress”
    • You’ll receive a link to the published article

📋 Instrukcja użytkowania

1. Konfiguracja WordPress

2. Konfiguracja Ollama

3. Konfiguracja Git

4. Generowanie artykułu

5. Publikacja

📁 Project Structure

wordpress-git-publisher/
├── server.js              # Backend Express.js
├── package.json           # Node.js dependencies
├── package-lock.json      # Lock file for dependencies
├── public/                # Frontend assets
│   ├── css/
│   │   └── styles.css    # Frontend styles
│   ├── js/
│   │   └── app.js       # Frontend JavaScript
│   └── index.html         # Frontend application
├── logs/                  # Application logs
├── .env.example          # Example environment variables
├── .gitignore            # Git ignore rules
├── Makefile              # Development tasks
├── start.sh              # Startup script
├── stop.sh               # Shutdown script
└── README.md             # This documentation

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Polski

✨ Funkcje

🚀 Szybki start

  1. Sklonuj repozytorium 
    git clone https://github.com/your-username/wordpress-git-publisher.git
cd wordpress-git-publisher
  2. Zainstaluj zależności 
    make install
  3. Skonfiguruj środowisko 
    cp .env.example .env
# Edytuj plik .env zgodnie z konfiguracją
  4. Uruchom aplikację 
    make start
  5. Otwórz interfejs w przeglądarce 
    http://localhost:3001

🔧 Użycie

Dostępne komendy

# Instalacja zależności
make install

# Uruchomienie aplikacji
make start

# Zatrzymanie aplikacji
make stop

# Restart aplikacji
make restart

# Uruchomienie w trybie developerskim z automatycznym przeładowywaniem
make dev

# Czyszczenie plików tymczasowych
make clean

# Usunięcie node_modules i logów
make distclean

# Wyświetlenie pomocy
make help

📄 Licencja

Ten projekt jest dostępny na licencji MIT - szczegóły w pliku LICENSE.

🔧 API Endpoints

Endpoint Method Description
/api/health GET Check server status
/api/test-wordpress POST Test WordPress connection
/api/test-ollama POST Test Ollama connection
/api/scan-git POST Scan Git repositories
/api/generate-article POST Generate AI article
/api/publish-wordpress POST Publish to WordPress

📊 Git Data Format

The application analyzes the following commit information:

🎨 Example Generated Article

<h1>Project Updates - 2025-06-04</h1>

<p>Today was a productive day in my development projects...</p>
Made with ❤️ by Your Name | [Contribute](CONTRIBUTING.md)

Projekt: wordpress-publisher

W projekcie wordpress-publisher zrealizowałem następujące zadania:

Podsumowanie

Łącznie dzisiaj wykonałem 5 commitów w 2 projektach...


## 🛡️ Bezpieczeństwo

- **Application Passwords** zamiast zwykłych haseł WordPress
- **Lokalne przetwarzanie** - dane Git nie opuszczają Twojego serwera
- **HTTPS zalecane** dla produkcji
- **Walidacja danych** na wszystkich endpointach API

## 🚀 Uruchamianie aplikacji

### Rozpoczęcie pracy

```bash
# Instalacja zależności
make install

# Uruchomienie serwerów (backend i frontend)
make start

# W przeglądarce otwórz:
# - Frontend: http://localhost:8088
# - Backend API: http://localhost:3001

Inne przydatne komendy

# Zatrzymanie wszystkich usług
make stop

# Restart usług
make restart

# Tryb developerski z automatycznym przeładowaniem
make dev

# Czyszczenie plików tymczasowych
make clean

# Pełne czyszczenie (włącznie z node_modules)
make distclean

🔧 Rozwiązywanie problemów

Błąd: “Ollama nie odpowiada”

# Sprawdź czy Ollama działa
ollama list

# Uruchom Ollama jeśli nie działa
ollama serve

Błąd: “Brak modelu mistral:7b”

# Pobierz wymagany model
ollama pull mistral:7b

# Sprawdź dostępne modele
ollama list

Błąd: “WordPress 401 Unauthorized”

  1. Sprawdź czy Application Password jest poprawne
  2. Upewnij się, że użytkownik ma uprawnienia do publikowania
  3. Sprawdź czy WordPress REST API jest włączone

Błąd: “Nie znaleziono repozytoriów Git”

  1. Sprawdź ścieżkę do folderów GitHub
  2. Upewnij się, że foldery zawierają repozytoria Git (folder .git)
  3. Sprawdź uprawnienia do odczytu folderów

🚀 Development

Tryb developmentu

npm run dev  # Nodemon z auto-restartowaniem

Uruchomienie testów

npm test

Linting kodu

npm run lint

📄 Licencja

MIT License - zobacz plik LICENSE

🤝 Wsparcie

W razie problemów:

  1. Sprawdź sekcję rozwiązywania problemów
  2. Sprawdź logi w konsoli przeglądarki i terminalu
  3. Otwórz issue na GitHub

🔄 Aktualizacje

Aby zaktualizować aplikację:

git pull origin main
npm install
npm restart

Autor: Twój Developer
Wersja: 1.0.0
Data: 2025-06-04

This site is open source. Improve this page.