Aristay is a comprehensive property management platform designed for modern hospitality operations. It features a robust Django REST API backend with JWT authentication, automated task management, and a Flutter mobile application for on-the-go property management.
- 🔐 JWT Authentication - Secure, token-based authentication system
- 📋 Booking Management - Comprehensive reservation and guest management
- 🤖 Task Automation - Automated cleaning and maintenance task creation
- 👥 Role-Based Access Control - Granular permission system
- 💬 Real-Time Chat - WebSocket-based messaging system with Django Channels
- 📱 Mobile Application - Flutter-based mobile interface
- 📊 Admin Dashboard - Staff management and reporting interface
- 📸 Photo Management - Before/after photo tracking and approval workflow
- 📅 Calendar System - Property and task scheduling interface
- Backend: Django REST Framework with PostgreSQL
- Real-Time: Django Channels with Redis for WebSocket support
- Frontend: Flutter mobile application
- Web UI: Django templates with modern JavaScript
- Authentication: JWT with djangorestframework-simplejwt
- Testing: Comprehensive test suite with pytest
- Deployment: Production-ready with security hardening
- Python 3.8+ with virtual environment
- Node.js and Flutter SDK
- PostgreSQL database
- Git
# Clone the repository
git clone <repository-url>
cd aristay_app
# Set up backend environment
cd aristay_backend
python -m venv .venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
pip install -r requirements.txt
# Set up environment variables
cp .env.example .env
# Edit .env with your configuration
# Run database migrations
python manage.py migrate
# Create superuser
python manage.py createsuperuser
# Start development server
python manage.py runserver# Navigate to Flutter directory
cd aristay_flutter_frontend
# Install dependencies
flutter pub get
# Run the app
flutter runAll project documentation is comprehensively organized in the docs/ directory:
- CLEANUP_PLAN.md - Project organization and cleanup strategy
- PROJECT_CLEANUP_SUMMARY.md - Recent reorganization summary
- docs/CURRENT_DOCUMENTATION.md - ⭐ Quick reference to active docs
- docs/DOCUMENTATION_INDEX.md - Complete documentation catalog
- Setup: Deployment Guide | Environment Config
- Features: Chat System | Calendar | Photo Management
- Security: JWT Authentication | Security Guide
- Testing: Testing Strategy | Test Organization
- Development: Local Setup | Project Structure
The project includes a comprehensive test suite organized by scope and purpose:
# Run all tests using the central test runner
python tests/run_tests.py
# Quick system validation
./scripts/testing/quick_test.sh
# JWT authentication testing
./scripts/testing/jwt_smoke_test_improved.sh
# Specific test categories
python tests/run_tests.py --production
python tests/run_tests.py --integration
python tests/run_tests.py --security- Unit Tests: Component-specific validation
- Integration Tests: Multi-component workflows
- Security Tests: Authentication and authorization
- Production Tests: Production readiness validation
- API Tests: Endpoint functionality testing
All development and administrative scripts are organized in scripts/:
# Testing scripts
scripts/testing/quick_test.sh # Comprehensive test runner
scripts/testing/jwt_smoke_test.sh # JWT validation
# Administrative scripts
scripts/admin/audit_user_access.py # User access audit
scripts/admin/seed_new_permissions.py # Permission seedingAristay implements enterprise-grade security:
- JWT Authentication with refresh tokens and secure headers
- Rate Limiting with redis-based throttling
- Role-Based Permissions with granular access control
- API Security with CORS, CSRF protection, and input validation
- Production Hardening with security headers and monitoring
For detailed security information, see the Security Documentation.
aristay_app/
├── README.md # This file
├── CLEANUP_PLAN.md # Project organization strategy
├── PROJECT_CLEANUP_SUMMARY.md # Reorganization summary
├── conftest.py # Global pytest configuration
├── pytest.ini # Test configuration
├── requirements.txt # Python dependencies
├── aristay_backend/ # Django REST API
│ ├── api/ # API application
│ │ ├── models_chat.py # Chat models
│ │ ├── views_chat.py # Chat views
│ │ ├── consumers.py # WebSocket consumers
│ │ └── templates/chat/ # Chat UI templates
│ ├── backend/ # Django settings
│ └── manage.py # Django management
├── aristay_flutter_frontend/ # Flutter mobile app
├── tests/ # Comprehensive test suite
│ ├── api/ # API tests
│ ├── chat/ # Chat system tests
│ ├── ui/ # UI tests
│ ├── backend/ # Backend tests
│ ├── archive/ # Archived legacy tests
│ └── utils/ # Test utilities
├── docs/ # Complete documentation
│ ├── CURRENT_DOCUMENTATION.md # ⭐ Quick reference
│ ├── features/chat/ # Chat documentation
│ ├── archive/ # Historical docs
│ └── reports/archive/ # Old reports
├── scripts/ # Development & admin scripts
└── tools/ # Development utilities
├── diagnostics/ # Debug tools
└── secret-hygiene/ # Security scanning
See CLEANUP_PLAN.md for the complete reorganization details.
✅ Production Ready - All core features implemented and tested ✅ Security Hardened - Comprehensive security implementation ✅ Well Documented - Complete documentation and guides ✅ Fully Tested - Comprehensive test coverage ✅ Organized Structure - Professional project organization (Nov 2025) ✅ Chat System - Real-time messaging with WebSocket support ✅ Clean Codebase - 60+ files reorganized for maintainability
- ✨ Fixed chat UI authentication and error handling
- 🗂️ Major project reorganization (60 files)
- 📚 Improved documentation structure
- 🧪 Centralized all tests
- 🔧 Fixed .gitignore configuration
For detailed status information, see PROJECT_CLEANUP_SUMMARY.md.
- Review Development Setup
- Follow Coding Standards
- Add comprehensive tests
- Update documentation
- Run full test suite
- Reproduce issue with test case
- Implement fix following coding standards
- Verify fix with all relevant tests
- Update documentation if needed
- Review Security Checklist
- Implement changes with security focus
- Run security-focused tests
- Document security implications
- Database Optimization: Efficient queries with proper indexing
- API Performance: Optimized endpoints with caching
- Mobile Performance: Efficient Flutter implementation
- Scalable Architecture: Modular design for growth
- Environment Setup: See Installation Guide
- Test Failures: See Testing Manual
- Deployment Issues: See Deployment Guide
- Check the Documentation Index
- Review relevant troubleshooting guides
- Check test output for specific error messages
- Consult security documentation for security-related issues
Copyright (c) 2025 Nguyen, Phuong Duy Lam. All rights reserved.
- Django REST Framework for robust API development
- Flutter for cross-platform mobile development
- JWT Authentication for secure token-based auth
- pytest for comprehensive testing framework
Aristay Property Management System - Professional, Secure, Scalable Last Updated: November 23, 2025 - Chat fixes and project reorganization