github/torrentpier
1
0
Fork 0
mirror of https://github.com/torrentpier/torrentpier synced 2025-08-22 14:23:57 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: enhance CLAUDE.md with migration details and directory updates

Browse source 
- Updated the `/library/` section to clarify its purpose.
- Added a new `/migrations/` directory section detailing database migration files managed by Phinx.
- Included migration commands for running and checking migration status.
- Revised the initial schema and seed data references for clarity.
- Improved formatting for consistency throughout the document.
This commit is contained in:
Yury Pikhtarev 2025-06-20 04:10:06 +04:00
commit 5af6a9433a
No known key found for this signature in database
1 changed files with 19 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

23
CLAUDE.md
View file

@ -17,12 +17,13 @@ TorrentPier is a BitTorrent tracker engine written in PHP, designed for hosting
## Key Directory Structure ## Key Directory Structure
- `/src/` - Modern PHP classes (PSR-4 autoloaded as `TorrentPier\`) - `/src/` - Modern PHP classes (PSR-4 autoloaded as `TorrentPier\`)
- `/library/` - Core application logic and legacy code - `/library/` - Core application logic and legacy code
- `/admin/` - Administrative interface - `/admin/` - Administrative interface
- `/bt/` - BitTorrent tracker functionality (announce.php, scrape.php) - `/bt/` - BitTorrent tracker functionality (announce.php, scrape.php)
- `/styles/` - Templates, CSS, JS, images - `/styles/` - Templates, CSS, JS, images
- `/internal_data/` - Cache, logs, compiled templates - `/internal_data/` - Cache, logs, compiled templates
- `/install/` - Installation scripts and SQL schema - `/install/` - Installation scripts and configuration examples
- `/migrations/` - Database migration files (Phinx)
## Entry Points & Key Files ## Entry Points & Key Files
@ -86,7 +87,7 @@ The project uses **StyleCI** with PSR-2 preset for code style enforcement. Style
### CI/CD Pipeline ### CI/CD Pipeline
- **GitHub Actions** for automated testing and deployment - **GitHub Actions** for automated testing and deployment
- **StyleCI** for code style enforcement - **StyleCI** for code style enforcement
- **Dependabot** for dependency updates - **Dependabot** for dependency updates
- **FTP deployment** to demo environment - **FTP deployment** to demo environment
@ -97,10 +98,24 @@ The project uses **StyleCI** with PSR-2 preset for code style enforcement. Style
## Database & Schema ## Database & Schema
- MySQL schema: `/install/sql/mysql.sql` - **Database migrations** managed via Phinx in `/migrations/` directory
- Initial schema: `20250619000001_initial_schema.php`
- Initial seed data: `20250619000002_seed_initial_data.php`
- UTF-8 (utf8mb4) character set required - UTF-8 (utf8mb4) character set required
- Multiple database alias support for different components - Multiple database alias support for different components
### Migration Commands
```bash
# Run all pending migrations
php vendor/bin/phinx migrate --configuration=phinx.php
# Check migration status
php vendor/bin/phinx status --configuration=phinx.php
# Mark migrations as applied (for existing installations)
php vendor/bin/phinx migrate --fake --configuration=phinx.php
```
## Legacy Compatibility Strategy ## Legacy Compatibility Strategy
The codebase maintains 100% backward compatibility while introducing modern alternatives: The codebase maintains 100% backward compatibility while introducing modern alternatives: