🔧 Build Process Improvements: - Update default 'build' target to use development mode - Add new 'build-prod' target for production builds with validation - Fix 'deploy-prod-quick' to use production build command - Update 'build-test' to use development build (safer for CI) 📚 Documentation: - Add comprehensive Production Build Guide (docs/deployment/PRODUCTION_BUILD.md) - Include security requirements, configuration methods, and troubleshooting - Update main documentation index with production build guide - Update README with both build command options ✨ Features: - Development builds work without security configuration - Production builds require proper JWT/SESSION secrets - Clear separation between dev and prod build processes - Comprehensive production deployment documentation 🔒 Security: - Enforced JWT_SECRET validation for production builds - Clear documentation of required security configurations - Examples for CI/CD integration with proper secret management - Best practices for production deployment 🧪 Verification: - ✅ Development build: make build (works with warnings) - ✅ Production build validation: make build-prod (fails without secrets) - ✅ Production build with secrets: works correctly - ✅ All existing functionality preserved
3.8 KiB
3.8 KiB
📚 Documenta#### 💻 Development
- API Documentation - REST API endpoints and usage
- Code Quality - Linting, formatting, and quality standards
- Application Security - Application security practices
- Security Changes - Recent security updates and changesndex
Welcome to the RxMinder documentation! This guide will help you navigate through all available documentation organized by category.
🏗️ Architecture & Design
- Project Structure - Complete overview of the codebase organization
- Template Approach - Design philosophy and template methodology
🚀 Setup & Configuration
- Complete Template Configuration - Full setup guide
- Setup Complete - Post-setup verification checklist
💻 Development
- API Documentation - REST API endpoints and usage
- Database Service - Database abstraction layer and strategy pattern implementation
- Code Quality - Linting, formatting, and quality standards
- Security - Security guidelines and best practices
- Security Changes - Recent security updates and changes
🚢 Deployment
- Deployment Guide - General deployment instructions
- Production Build Guide - Production build configuration and security
- Docker Configuration - Docker setup and configuration
- Gitea Setup - Gitea CI/CD configuration
- Storage Configuration - Database and storage setup
🔄 Migration Guides
- NodeJS Pre-commit Migration - Migration from Python to NodeJS pre-commit hooks
- Buildx Migration - Docker Buildx migration guide
📝 Project Information
- README - Main project overview and quick start
- Contributing - How to contribute to the project
- Changelog - Version history and changes
- License - Project license information
📋 Documentation Meta
- Documentation Reorganization - How we restructured the docs
- Docs Update Summary - Legacy documentation summary
🔍 Quick Navigation
For New Developers
- Start with README
- Review Project Structure
- Follow Complete Template Configuration
- Read Code Quality guidelines
For Deployment
- Read Deployment Guide
- Configure Production Build for secure deployment
- Configure Docker
- Set up Storage
- Review Security requirements
For API Integration
- Check API Documentation
- Review Database Service for data operations
- Review Security requirements
For Migration Tasks
- NodeJS Pre-commit Migration - For modernizing git hooks
- Buildx Migration - For Docker build improvements
📋 Last Updated: January 2024
🔄 Documentation Version: 2.1
📦 Project Version: 0.0.0