From c944d76ed84eae41e0ee7c1ba0692f74514603df Mon Sep 17 00:00:00 2001 From: Ryan Date: Sun, 8 Feb 2026 03:13:26 -0500 Subject: [PATCH] docs(dev): update repo layout for PSR-4 + chore(gitignore): ignore local data, IDE files, and tooling caches --- .gitignore | 29 ++++++++++++++++++++++++++++- docs/wiki/dev guide.md | 12 ++++++++---- 2 files changed, 36 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index 5fac628..681d0f7 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,28 @@ -/data/ \ No newline at end of file +/data/ +.DS_Store + +# Editor/IDE +.idea/ +.vscode/ + +# Local env/secrets +.env +.env.* +!.env.example + +# Local runtime data (avoid accidentally committing user files) +/uploads/ +/users/ +/metadata/ +/sessions/ + +# Tooling caches +.phpunit.result.cache +.phpcs-cache +.php-cs-fixer.cache + +# Logs/temp +*.log +*.swp +*.swo +*~ diff --git a/docs/wiki/dev guide.md b/docs/wiki/dev guide.md index 0b9ab8c..6dfbe77 100644 --- a/docs/wiki/dev guide.md +++ b/docs/wiki/dev guide.md @@ -5,9 +5,13 @@ Contributions are welcome. See `CONTRIBUTING.md` for workflow and PR guidelines. ## Repo structure (core) - `public/` - frontend assets + entrypoints (`index.html`, `api.php`, `webdav.php`) -- `src/controllers/` - request handlers -- `src/models/` - data logic (users, auth, admin config) -- `src/lib/` - shared utilities (ACL, crypto, storage) +- `src/FileRise/` - PSR-4 backend tree (namespaced `FileRise\\...`) + - `src/FileRise/Http/Controllers/` - request handlers + - `src/FileRise/Domain/` - models / business logic (users, auth, admin config, etc.) + - `src/FileRise/Support/` - shared utilities (ACL, crypto, filesystem helpers) + - `src/FileRise/Storage/` - storage + sources + - `src/FileRise/WebDAV/` - WebDAV support +- `src/controllers/`, `src/models/`, `src/lib/`, `src/webdav/` - legacy shims (compat layer via `class_alias`) - `scripts/` - CLI helpers (e.g., `scan_uploads.php`) ## Local dev quick start @@ -27,7 +31,7 @@ FR_TEST_META_DIR=/tmp/filerise/metadata ## OpenAPI spec -- Source: `src/openapi/` and `public/api/` annotations +- Source: `src/FileRise/OpenApi/` and `public/api/` annotations - Generate spec: ```bash