Implement proper asset management with capacitor-assets
- Add capacitor-assets.config.json for cross-platform asset generation - Create resources/ directory structure for source assets - Update .gitignore to exclude generated Android assets and resources - Remove 30+ generated files from source control - Add comprehensive asset management documentation - Verify asset generation works with new configuration Assets are now properly managed: source files in version control, generated files excluded, and build process handles platform-specific asset generation automatically.
79
resources/README.md
Normal file
@@ -0,0 +1,79 @@
|
||||
# TimeSafari Resources Directory
|
||||
|
||||
This directory contains source assets for the TimeSafari application across all platforms.
|
||||
|
||||
## Directory Structure
|
||||
|
||||
```
|
||||
resources/
|
||||
├── android/
|
||||
│ ├── icon/
|
||||
│ │ └── icon.png
|
||||
│ └── splash/
|
||||
│ ├── splash.png
|
||||
│ └── splash_dark.png
|
||||
├── ios/
|
||||
│ ├── icon/
|
||||
│ │ └── icon.png
|
||||
│ └── splash/
|
||||
│ ├── splash.png
|
||||
│ └── splash_dark.png
|
||||
└── web/
|
||||
├── icon/
|
||||
│ └── icon.png
|
||||
└── images/
|
||||
```
|
||||
|
||||
## Asset Requirements
|
||||
|
||||
### Icon Requirements
|
||||
- **Format**: PNG
|
||||
- **Size**: 1024x1024 pixels minimum
|
||||
- **Background**: Transparent or solid color
|
||||
- **Content**: App logo/icon
|
||||
|
||||
### Splash Screen Requirements
|
||||
- **Format**: PNG
|
||||
- **Size**: 1242x2688 pixels (iPhone 11 Pro Max size)
|
||||
- **Background**: Solid color or gradient
|
||||
- **Content**: App logo centered
|
||||
|
||||
## Asset Generation
|
||||
|
||||
Assets are automatically generated during the build process using `capacitor-assets`:
|
||||
|
||||
```bash
|
||||
# Generate assets for all platforms
|
||||
npx capacitor-assets generate
|
||||
|
||||
# Generate assets for specific platform
|
||||
npx capacitor-assets generate --ios
|
||||
npx capacitor-assets generate --android
|
||||
npx capacitor-assets generate --web
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
Asset generation is configured in `capacitor-assets.config.json` at the project root.
|
||||
|
||||
## Version Control
|
||||
|
||||
- **Source assets** (this directory): ✅ In version control
|
||||
- **Generated assets**: ❌ Not in version control (excluded by `.gitignore`)
|
||||
|
||||
## Updating Assets
|
||||
|
||||
1. Replace the source asset files in the appropriate platform directory
|
||||
2. Run the build process to regenerate platform-specific assets
|
||||
3. Test the generated assets on target platforms
|
||||
|
||||
## Build Integration
|
||||
|
||||
Assets are automatically generated as part of the build process:
|
||||
- `npm run build:android` - Generates Android assets
|
||||
- `npm run build:ios` - Generates iOS assets
|
||||
- `npm run build:web` - Generates web assets
|
||||
|
||||
**Author**: Matthew Raymer
|
||||
**Date**: 2025-01-27
|
||||
**Status**: ✅ **ACTIVE** - Asset management system implemented
|
||||
BIN
resources/android/icon/icon.png
Normal file
|
After Width: | Height: | Size: 279 KiB |
BIN
resources/android/splash/splash.png
Normal file
|
After Width: | Height: | Size: 1.9 MiB |
BIN
resources/android/splash/splash_dark.png
Normal file
|
After Width: | Height: | Size: 1.9 MiB |
BIN
resources/ios/icon/icon.png
Normal file
|
After Width: | Height: | Size: 279 KiB |
BIN
resources/ios/splash/splash.png
Normal file
|
After Width: | Height: | Size: 1.9 MiB |
BIN
resources/ios/splash/splash_dark.png
Normal file
|
After Width: | Height: | Size: 1.9 MiB |
BIN
resources/web/icon/icon.png
Normal file
|
After Width: | Height: | Size: 279 KiB |