🔐 LegacyVault

Secure Asset Legacy Management System

LegacyVault is a modern, secure platform for managing digital wills and encrypted assets with conditional release mechanisms. Built with Django and featuring a beautiful, animated frontend with a profound color palette.

✨ Features

Core Functionality

📋 Digital Wills Management: Create and manage multiple digital wills
🔒 End-to-End Encryption: Assets are encrypted; even the platform can't read them
⏳ Smart Release Conditions:
- Time-based releases
- Inactivity-based releases
- Approval-based releases (executor approval)
👥 Participant Management: Add executors and beneficiaries to wills
📊 Full Audit Trail: All actions are logged for transparency and compliance
⚙️ Inactivity Handling: Automatic handling of wills based on user inactivity

Production-Ready Upgrades

🔌 REST API Framework (Django REST Framework 3.15.1)
- 50+ fully documented API endpoints
- JWT token authentication with refresh tokens
- Swagger UI & ReDoc interactive documentation
- Pagination, filtering, and search capabilities
- Rate limiting (100 req/hour anonymous, 1000 req/hour authenticated)
⚡ Async Task Processing (Celery 5.3.4 + Redis 5.0.1)
- Background job queue for non-blocking operations
- Scheduled tasks (inactivity checks, email sending, session cleanup)
- Celery Beat scheduler for recurring tasks
- Redis message broker and caching
🔐 Two-Factor Authentication (TOTP-based)
- TOTP 2FA with QR code generation
- Backup codes (10 per user)
- API endpoints for setup and management
- QR code support with qrcode library
📈 Error Tracking & Monitoring (Sentry SDK 1.40.0)
- Production error tracking with Sentry
- Django + Celery integrations
- Automatic error reporting and alerting

Smart Features

🤖 Auto-Calculation: File size and SHA256 hash auto-generated on asset upload
📧 Email Notifications: Automatic emails for inactivity warnings and release requests
🔄 Session Management: Automatic cleanup of expired sessions

Modern Frontend

🎨 Profound Color Palette: Deep navy blues, rich purples, and teal accents
✨ Smooth Animations: Fade-in, slide, and hover effects throughout
📱 Responsive Design: Mobile-first approach with full tablet and desktop support
🔖 Tabbed Interface: Organized dashboard with separate tabs for different sections
💫 Interactive Elements: Cards with hover effects, ripple animations, and smooth transitions
🎯 Modern UI Components: Beautiful forms, buttons, badges, and cards

🚀 Quick Start

Prerequisites

Python 3.8 or higher
MySQL 5.7+ or higher (required)
pip (Python package manager)

Installation

Clone the repository

git clone <repository-url>
cd Legacy_System

Create a virtual environment

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

Install dependencies
```
pip install -r requirements.txt
```

Set up environment variables Create a .env file in the project root:

DJANGO_SECRET_KEY=your-secret-key-here
DJANGO_DEBUG=1
DJANGO_ALLOWED_HOSTS=localhost,127.0.0.1

# MySQL Database Configuration (Required)
MYSQL_DATABASE=legacyvault
MYSQL_USER=legacyvault
MYSQL_PASSWORD=your-password
MYSQL_HOST=127.0.0.1
MYSQL_PORT=3306

Run migrations
```
python manage.py migrate
```
Create a superuser (optional)
```
python manage.py createsuperuser
```

Collect static files

python manage.py collectstatic --noinput

Start the development server
```
python manage.py runserver
```
Start background services (in separate terminals)

Option A: Development (without async tasks)
```
# Server is ready at http://127.0.0.1:8000/
```
Option B: Full production-like setup (with async tasks) Terminal 2 - Start Redis (required for Celery):
```
redis-server
```
Terminal 3 - Start Celery Worker:
```
celery -A legacyvault worker -l info
```
Terminal 4 - Start Celery Beat (scheduler):
```
celery -A legacyvault beat -l info
```
Access the application
- Homepage: http://127.0.0.1:8000/
- Admin Panel: http://127.0.0.1:8000/admin/
- API Documentation (Swagger): http://127.0.0.1:8000/api/docs/swagger/
- API Documentation (ReDoc): http://127.0.0.1:8000/api/docs/redoc/

📁 Project Structure

Legacy_System/
├── apps/
│   ├── accounts/          # User authentication and inactivity settings
│   ├── audit/             # Audit logging system
│   └── wills/             # Core wills and assets management
├── legacyvault/          # Django project settings
├── static/               # Static files (CSS, JS, images)
│   ├── frontend/
│   │   └── assets/
│   │       ├── index.css  # Frontend styles (imports main CSS)
│   │       └── index.js   # Frontend JavaScript
│   └── style.css         # Main stylesheet with modern design
├── templates/            # Django templates
│   ├── base.html         # Base template
│   ├── accounts/         # Authentication templates
│   └── wills/            # Wills management templates
├── requirements.txt      # Python dependencies
└── README.md            # This file

🎨 Frontend Architecture

Color Palette

The frontend uses a profound color scheme:

Primary Colors: Deep navy blues (#0a1628 to #bad5ff)
Accent Colors: Rich purple (#6c5ce7), Teal (#00b894), Gold (#fdcb6e)
Semantic Colors: Success (teal), Warning (gold), Danger (coral), Info (blue)

Key Features

CSS Variables: All colors and spacing defined as CSS variables for easy customization
Animations: Smooth transitions, fade-ins, and hover effects
Responsive Grid: Flexible grid system for cards and layouts
Tab System: JavaScript-powered tabs for organized content
Form Enhancements: Real-time validation feedback and loading states

JavaScript Functionality

Tab switching with smooth transitions
Scroll-triggered animations using Intersection Observer
Form validation and enhancement
Card interactions with ripple effects
Smooth scrolling for anchor links

🔧 Configuration

Database Configuration

MySQL (Required)

MYSQL_DATABASE=legacyvault
MYSQL_USER=legacyvault
MYSQL_PASSWORD=your-password
MYSQL_HOST=127.0.0.1
MYSQL_PORT=3306

Note: LegacyVault requires MySQL 5.7+ or higher. SQLite is not supported.

Security Settings

For production, set these environment variables:

DJANGO_SECRET_KEY=your-strong-secret-key
DJANGO_DEBUG=0
DJANGO_SECURE_SSL_REDIRECT=1
DJANGO_SESSION_COOKIE_SECURE=1
DJANGO_CSRF_COOKIE_SECURE=1

📖 API Documentation

The project includes comprehensive REST API documentation:

Swagger UI: http://127.0.0.1:8000/api/docs/swagger/
ReDoc: http://127.0.0.1:8000/api/docs/redoc/
Full API Reference: See API_DOCUMENTATION.md

Authentication

API endpoints use JWT token authentication:

Get Token

curl -X POST http://127.0.0.1:8000/api/v1/auth/token/ \
  -H "Content-Type: application/json" \
  -d '{"username":"user","password":"pass"}'

Use Token in Requests

curl -H "Authorization: Bearer YOUR_TOKEN" \
  http://127.0.0.1:8000/api/v1/wills/

📊 Documentation Files

API_DOCUMENTATION.md - Complete REST API reference with 50+ endpoints
UPGRADE_GUIDE.md - Comprehensive guide to new features (REST, Celery, 2FA, Sentry)
QUICK_REFERENCE.md - Quick start guide for common tasks
COMPLETION_SUMMARY.md - Deployment and production readiness checklist
UPGRADE_SUMMARY.md - Overview of all upgrades and enhancements
SHA256_AUTO_GENERATION.md - Details on automatic SHA256 hash generation

🛠️ Development

Running Tests

python manage.py test

Creating Migrations

python manage.py makemigrations
python manage.py migrate

Collecting Static Files

python manage.py collectstatic

Code Style

The project follows PEP 8 Python style guidelines and uses Django's recommended practices.

🔐 Security Features

CSRF Protection: All forms are protected with CSRF tokens
Authentication Required: Most views require user authentication
Permission Checks: Users can only access their own wills and assets
Audit Logging: All actions are logged with IP addresses and user agents
Encrypted Storage: Assets are stored as ciphertext only

📝 API Endpoints

Main URLs

/ - Homepage
/accounts/login/ - User login
/accounts/signup/ - User registration
/accounts/logout/ - User logout
/accounts/inactivity_settings/ - Inactivity preferences
/wills/dashboard/ - Main dashboard
/wills/create/ - Create a new will
/admin/ - Django admin panel

🚢 Deployment

Quick Start with Docker

Build the Docker image:
```
docker build -t legacyvault .
```
Run with docker-compose:
```
docker-compose up -d
```

Manual Production Deployment

Set production environment variables in .env:

DJANGO_SECRET_KEY=your-strong-secret-key
DJANGO_DEBUG=0
DJANGO_ALLOWED_HOSTS=yourdomain.com

# Database
MYSQL_DATABASE=legacyvault
MYSQL_USER=legacyvault
MYSQL_PASSWORD=strong-password
MYSQL_HOST=db-server
MYSQL_PORT=3306

# Security
DJANGO_SECURE_SSL_REDIRECT=1
DJANGO_SESSION_COOKIE_SECURE=1
DJANGO_CSRF_COOKIE_SECURE=1

# Celery & Redis
CELERY_BROKER_URL=redis://localhost:6379/0
CELERY_RESULT_BACKEND=redis://localhost:6379/1

# Sentry (Error Tracking)
SENTRY_DSN=your-sentry-dsn-here

Run migrations:
```
python manage.py migrate
```

Collect static files:

python manage.py collectstatic --noinput

Start services:

Web Server (use Gunicorn):

gunicorn legacyvault.wsgi:application --bind 0.0.0.0:8000

Celery Worker:

celery -A legacyvault worker -l info

Celery Beat (Scheduler):

celery -A legacyvault beat -l info

Redis (Message Broker & Cache):

redis-server

Configure reverse proxy (Nginx example):

server {
    listen 80;
    server_name yourdomain.com;
    
    location / {
        proxy_pass http://127.0.0.1:8000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }
}

See COMPLETION_SUMMARY.md for detailed deployment instructions.

🤝 Contributing

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add some amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

📄 License

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

🙏 Acknowledgments

Django Framework
Firebase Admin SDK
All contributors and users

📞 Support

For issues, questions, or contributions, please open an issue on the GitHub repository.

🎯 Roadmap

✅ Completed

✅ REST API with 50+ endpoints (Django REST Framework)
✅ JWT authentication with token refresh
✅ Async task processing (Celery + Redis)
✅ Two-factor authentication (TOTP-based)
✅ Error tracking (Sentry integration)
✅ Automatic SHA256 hash generation
✅ Automatic file size calculation
✅ Rate limiting and security headers
✅ Request logging for audit trail
✅ Interactive API documentation (Swagger & ReDoc)
✅ Testing framework (pytest + pytest-django)
✅ Modern responsive frontend

🚀 Planned Features

Mobile app (using REST API)
Multi-language support
Advanced encryption options
Email notification templates customization
Role-based access control (RBAC)
Backup and recovery features
API rate limiting per user tier
Enhanced search and filtering

📸 Screenshots

📊 Recent Updates

Production-Ready Upgrades (Latest)

✅ REST API Framework: 50+ endpoints with JWT auth, pagination, filtering
✅ Async Task Processing: Celery + Redis for background jobs and scheduling
✅ Two-Factor Authentication: TOTP-based 2FA with backup codes and QR generation
✅ Error Tracking: Sentry integration for production monitoring
✅ Auto-Calculation: SHA256 hashing and file size auto-generated on upload
✅ Enhanced Security: CORS, rate limiting, security headers, request logging
✅ API Documentation: Interactive Swagger UI and ReDoc documentation
✅ Testing Suite: pytest + pytest-django with coverage reporting
✅ Comprehensive Documentation: 6 detailed guides covering all features

Previous Updates

✅ Frontend modernization with profound color palette
✅ Smooth animations and transitions
✅ Tabbed dashboard interface
✅ Responsive mobile-first design
✅ Modern form enhancements
✅ Interactive card components

Made with ❤️ for secure digital legacy management

Name		Name	Last commit message	Last commit date
accounts		accounts
audit		audit
docs		docs
legacyvault		legacyvault
static		static
templates		templates
wills		wills
COMPLETION_SUMMARY.md		COMPLETION_SUMMARY.md
Dockerfile		Dockerfile
QUICK_REFERENCE.md		QUICK_REFERENCE.md
README.md		README.md
docker-compose.yml		docker-compose.yml
manage.py		manage.py
requirements.txt		requirements.txt

Latest commit

History

Folders and files

Repository files navigation