VoucherVault  by l4rm4nd

Web app for digital voucher, coupon, and gift card management

Created 1 year ago
376 stars

Top 75.5% on SourcePulse

GitHubView on GitHub
Project Summary

VoucherVault is a Django-based web application designed for the digital management of vouchers, coupons, loyalty cards, and gift cards. It targets individuals and potentially small businesses looking for a centralized, user-friendly platform to track and manage these items, offering features like expiry notifications, transaction history, and SSO integration.

How It Works

The application leverages Django's robust framework for its web portal and REST API. It supports client-side scanning of redeem codes using QR or barcode detection, automatically identifying code types. Expiry notifications are managed via the Apprise library, with scheduled checks performed daily using Django-Celery-Beat and a Redis instance. Data persistence is handled by either SQLite3 or PostgreSQL, with Docker bind mounts recommended for data backup.

Quick Start & Requirements

  • Install via Docker Compose: docker compose -f docker/docker-compose-sqlite.yml up -d
  • Requires Docker and Docker Compose.
  • Ensure correct permissions for the volume data directory: sudo chown -R 33:33 volume-data/*
  • Access the web portal at http://127.0.0.1:8000. Default user: admin. Password found in container logs.
  • Official Wiki: https://github.com/l4rm4nd/VoucherVault/wiki

Highlighted Details

  • Mobile-optimized web portal with light/dark theme support.
  • Supports QR/barcode display and client-side scanning.
  • OIDC SSO integration for authentication.
  • REST API endpoint with stats for Home Assistant.
  • Multi-language support (EN, DE, FR, IT).

Maintenance & Community

  • Follows Conventional Commits standard.
  • Docker images are tagged with release versions.

Licensing & Compatibility

  • License: MIT.
  • Compatible with commercial use and closed-source linking.

Limitations & Caveats

The application is primarily distributed via Docker, and manual setup outside of Docker is not detailed. Transaction history is only supported for gift cards.

Health Check
Last Commit

1 day ago

Responsiveness

1 day

Pull Requests (30d)
0
Issues (30d)
0
Star History
12 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.