forked from jsnbuchanan/crowd-funder-for-time-pwa
docs: comprehensive documentation updates and modernization
- Update BUILDING.md with current build system information - Modernize various README files across the project - Update CHANGELOG.md with recent changes - Improve documentation consistency and formatting - Update platform-specific documentation (iOS, Electron, Docker) - Enhance test documentation and build guides
This commit is contained in:
@@ -7,18 +7,22 @@ This document summarizes the comprehensive cleanup and improvements made to the
|
||||
## Key Issues Resolved
|
||||
|
||||
### 1. Platform Detection Problems
|
||||
|
||||
- **Before**: `PlatformServiceFactory` only supported "capacitor" and "web" platforms
|
||||
- **After**: Added proper "electron" platform support with dedicated `ElectronPlatformService`
|
||||
|
||||
### 2. Build Configuration Confusion
|
||||
|
||||
- **Before**: Electron builds used `VITE_PLATFORM=capacitor`, causing confusion
|
||||
- **After**: Electron builds now properly use `VITE_PLATFORM=electron`
|
||||
|
||||
### 3. Missing Platform Service Methods
|
||||
|
||||
- **Before**: Platform services lacked proper `isElectron()`, `isCapacitor()`, `isWeb()` methods
|
||||
- **After**: All platform services implement complete interface with proper detection
|
||||
|
||||
### 4. Inconsistent Build Scripts
|
||||
|
||||
- **Before**: Mixed platform settings in build scripts
|
||||
- **After**: Clean, consistent electron-specific build process
|
||||
|
||||
@@ -215,11 +219,13 @@ if (capabilities.hasFileDownload) {
|
||||
## File Structure Changes
|
||||
|
||||
### New Files
|
||||
|
||||
- `vite.config.electron.mts` - Electron-specific Vite configuration
|
||||
- `src/main.electron.ts` - Electron main entry point
|
||||
- `doc/electron-cleanup-summary.md` - This documentation
|
||||
|
||||
### Modified Files
|
||||
|
||||
- `src/services/PlatformServiceFactory.ts` - Added electron platform support
|
||||
- `src/services/PlatformService.ts` - Added platform detection methods
|
||||
- `src/services/platforms/CapacitorPlatformService.ts` - Added missing interface methods
|
||||
@@ -301,4 +307,4 @@ For developers working with the previous implementation:
|
||||
- [ ] Implement desktop-specific UI components
|
||||
- [ ] Add Electron auto-updater integration
|
||||
- [ ] Create platform-specific testing utilities
|
||||
- [ ] Add desktop notification system integration
|
||||
- [ ] Add desktop notification system integration
|
||||
|
||||
Reference in New Issue
Block a user