https://github.com/tiehfood/xpferd
Simple app to design single page invoices and export XRechnung and ZUGFeRD conform files
https://github.com/tiehfood/xpferd
germany invocie invoice-generator svelte wysiwyg xrechnung zugferd
Last synced: 3 months ago
JSON representation
Simple app to design single page invoices and export XRechnung and ZUGFeRD conform files
- Host: GitHub
- URL: https://github.com/tiehfood/xpferd
- Owner: tiehfood
- License: bsd-2-clause
- Created: 2026-03-15T21:55:27.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-04-03T10:12:38.000Z (3 months ago)
- Last Synced: 2026-04-03T19:55:57.104Z (3 months ago)
- Topics: germany, invocie, invoice-generator, svelte, wysiwyg, xrechnung, zugferd
- Language: TypeScript
- Homepage: https://buymeacoffee.com/tiehfood
- Size: 2.72 MB
- Stars: 60
- Watchers: 0
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# X(P)FeRD
I needed a simple application for creating, managing and exporting XRechnung XML and ZUGFeRD PDF invoices (German e-invoicing standard).
Especially a simple WYSIWYG PDF designer was something I was looking for but couldn't find an existing solution I liked.
So I build this little app.
It's probably not perfect as my testing data is limited but feel free to report any issues or submit PRs if you want to contribute.
I will be honest about the usage of AI. It assisted me in this project, but it's still nothing, you create with just two or three promts. There went some serious thinking in it, particularly in the features.
About the name: The "X" was taken from XRechnung obviously and part of ZUGFeRD is so closely to "Pferd" (Horse) in german, so I combined both and made an "XPferd" out of it.
## Features
- Create and edit invoices with all legally required fields for Germany
- Export invoices as XRechnung 3.0 compliant XML
- Design single page invoice PDF with WYSIWYG editor
- Support for SVG logos
- Use custom fonts (TTF/OFT)
- Custom and common help lines (including envelope window, folding marks and borders)
- Export invoices as ZUGFeRD 2.1 compliant PDF (with embedded XML)
- Duplicate invoices or create from templates
- Swagger API documentation at `/api-docs`
- Support for Germany and English language
- Import existing XML invoices (XRechnung & UBL)
- Create recurring invoices automatically with custom intervals
- Send invoices via email (SMTP) with ZUGFeRD PDF / XRechnung XML attachments
- Email templates with placeholder and HTML support
- Encrypted SMTP password storage (AES-256-GCM)
## Screenshots
|  |  |
|:---------------------------------------------:|:---------------------------------------------:|
|  |  |
|  |  |
## Docker image
**Latest:** [tiehfood/xpferd:latest](https://hub.docker.com/r/tiehfood/xpferd/tags?name=latest)
*(or specific tag from release page, just the number without the leading `v`)*
## Quick Start
```bash
# Minimal
docker run -v xpferd:/app/data -p 3000:3000 tiehfood/xpferd:latest
# Production
docker-compose up production
# Development
docker-compose up dev
```
The app is available at `http://localhost:3000` for production.
## Environment Variables
| Variable | Required | Description |
|----------|----------|-------------|
| `ENCRYPTION_KEY` | No | 64-character hex string (32 bytes) used to encrypt SMTP passwords at rest (AES-256-GCM). If not set, a key is auto-generated and stored at `data/.encryption-key` inside the container. |
```bash
# Example: Generate encryption key
openssl rand -hex 32
```
## Manual Docker Setup
```bash
# Build the dev image
docker build -f Dockerfile.dev -t xrechnung-dev .
# Start a persistent dev container
docker run -d --name xr-dev \
-v "$(pwd):/app" \
-p 3000:3000 \
xrechnung-dev
# Install dependencies
docker exec xr-dev pnpm install
# Build the frontend
docker exec xr-dev node build-client.js
# Start the server
docker exec xr-dev npx tsx src/server/index.ts
```
## Running Tests
```bash
docker exec xr-dev npx vitest run
```
Or via Docker Compose:
```bash
docker-compose run --rm test
```
## Frameworks & Libraries
- **Application:** TypeScript, Svelte 5, Express
- **Database:** SQLite
- **PDF Generation:** @libpdf/core
- **XML Generation:** xmlbuilder2 (UBL 2.1 / XRechnung 3.0)
- **API Documentation:** Swagger-UI (`/api-docs`)
## Credits
- [XRechnung 3.0](https://xeinkauf.de/xrechnung/versionen-und-bundles/)
- [ZUGFeRD 2.1](https://www.ferd-net.de/standards/zugferd/)
___
