mirror of
https://github.com/narrrl/holy-flavor-rater.git
synced 2026-11-03 16:41:27 +01:00
89a4e51101eec69f51f5c59bbd3de5639f1c01ff
Holy Flavor Rater
A high-density, community-driven platform for "Holy Energy" enthusiasts. Browse every flavor ever released—from current bestsellers to retired legacy editions—rate them, and build your own personal tiered leaderboard to share with the world.
🚀 Key Features
- Personalized Taste Profiles: Interactive, tiered (S-D) leaderboards based on your personal ratings.
- Dynamic Hall of Fame: Automatic carousel featuring community-favorite flavors and highlighted reviews.
- Advanced Search & Discovery: Typo-friendly search with category-aware filtering and relevance sorting.
- Interactive Banners: 10+ procedurally generated Canvas banners (Fireflies, Hextech, Nebula, etc.) that react to your mouse.
- Pro Themes: Over 15 built-in themes including Catppuccin, Nord, and T0P (Twenty One Pilots) inspired aesthetics.
- Social Interaction: Follow other collectors, receive follow notifications, and leave messages in profile guestbooks.
- Enterprise Verification: Secure one-click email verification and password recovery.
- Automated Catalog: Real-time syncing with Shopify APIs and historical legacy flavor data.
🛠️ Setup & Installation
Option 1: Docker (Recommended)
The easiest way to get the full stack (Backend + Frontend + DB) running behind a production-ready proxy.
- Clone the repository:
git clone https://github.com/nvrl/Holy-Flavor-Rater.git cd Holy-Flavor-Rater - Environment Configuration:
cp .env.example .env # Edit .env with your SMTP settings and Domain - Start Services:
Note: On first startup, the backend will automatically migrate, sync the flavor catalog, and clean up any duplicates.
docker-compose up -d --build
Option 2: Local Manual Setup (Development)
Backend
- Navigate and Install:
cd backend python -m venv venv source venv/bin/activate # Linux/Mac pip install -r requirements.txt - Initialize DB:
python manage.py migrate python manage.py sync_flavors python manage.py seed_legacy_flavors - Run Server:
python manage.py runserver
Frontend
- Navigate and Install:
cd frontend npm install - Run Dev Server:
npm run dev
🏗️ Architecture
The Holy Flavor Rater uses a modern decoupled architecture:
Backend (Django REST Framework)
- Models: Custom User model, Flavors (with category constraints), Ratings (with mention parsing), and Dynamic Banners.
- Automation: Management commands for periodic Shopify API syncing and database deduplication.
- Security: Token-based authentication, CSRF protection, and email-verified account activation.
- Monitoring: Integrated
/health/endpoint for Docker container status.
Frontend (React 19 + TypeScript)
- State Management: React Hooks and local state for high performance.
- UI Framework: Material UI (MUI) with heavy customization for "Holy" branding.
- Visualization: Procedural generative art system using HTML5 Canvas for profile backgrounds.
- Internationalization: Full i18next integration (English & German).
💻 Development Workflow
Integrity Protection
This project includes a Pre-Push Git Hook to ensure code quality. It automatically:
- Attempts a full Frontend build (
tsc+vite build). - Runs Backend system checks and validates missing migrations.
To install the hooks:
bash scripts/install-hooks.sh
Management Commands
python manage.py sync_flavors: Syncs the latest products from the official Holy Energy API.python manage.py cleanup_duplicates: Merges duplicate entries and maintains rating integrity.python manage.py seed_banners: Updates procedurally generated banner configurations from JSON.python manage.py backup_db: Creates a consistent SQLite snapshot.
💾 Backups & Restoration
Create a Backup
To create a full snapshot of your database and user-uploaded media:
bash scripts/backup.sh
This will create a .tar.gz file in backend/backups/.
Automating with Cron:
Add this to your crontab -e to backup every night at 2:00 AM:
0 2 * * * /path/to/Holy-Flavor-Rater/scripts/backup.sh
Restore from Backup
- Extract the archive:
tar -xzf backup_filename.tar.gz - Stop the containers:
docker-compose down - Replace the current files:
cp extracted_folder/db.sqlite3 backend/db.sqlite3 cp -r extracted_folder/media/* backend/media/ - Restart:
docker-compose up -d
🌍 Production Configuration
Ensure your .env contains:
DEBUG=falseSECRET_KEY: A long random string.ALLOWED_HOSTS: Your domain (e.g.,holy.narl.io).FRONTEND_URL: For one-click email verification links.
📄 License
MIT
Languages
TypeScript
60.1%
Rust
38.8%
Dockerfile
0.4%
Shell
0.4%
HTML
0.2%
Other
0.1%