franzz/livetrail
1
0 Fork 0
Code Issues Pull Requests Actions Releases Wiki Activity

Dev guidelines for agents
Deploy Livetrail / deploy (push) Successful in 23s
Details

Browse Source
This commit is contained in:
franzz committed 2026-10-23 14:17:21 +02:00
1 parent 518e74dfb8
commit b0d8a79cdc
2 files changed
+169 -25
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

readme.md
-25
View File
@@ -35,31 +35,6 @@ Live Trail is a self-hosted web application for sharing journeys on an interacti
7. Add a GPX file named <project_codename>.gpx to /resources/geo/
8. Go to #admin and create a new project (with code name = <project_codename>) & feed
## Web Root
The web server should serve `public/` as the application document root. PHP source, configuration, Composer dependencies, uploaded files, and GPX data stay outside the public tree; `public/index.php` is the front controller and Vite writes generated frontend assets to `public/assets/`.
Runtime data is exposed through symlinks only: `public/files -> ../files` and `public/geo -> ../resources/geo`. The build must not copy uploaded media or GPX data into `public/`.
## Local Development
`npm run dev` watches and builds development assets into `public/assets/`. `npm run prod` builds hashed production assets into `public/assets/`. PHP reads `public/.vite/manifest.json` and populates the CSS, module, and preload parts defined in `resources/masks/index.html` while rendering the request.
When developing Livetrail and the sibling `objects` library together, install dependencies through the local Composer manifest:
```bash
COMPOSER=composer.dev.json composer update
```
This makes Composer link `vendor/franzz/objects` to `../objects` and autoload that namespace directly from the local source path. Production continues to use `composer.json`, which installs `franzz/objects` from its Git repository. Commit and publish `objects` changes before updating/deploying a Livetrail version that relies on them.
## Before Committing
Run manually before pushing:
* `composer lint` - checks PHP style (php-cs-fixer, dry-run); `composer lint-fix` applies it. Requires the dev dependencies (`COMPOSER=composer.dev.json composer update`, see Local Development above).
* `npm run lint` - checks JS/Vue style (ESLint) on demand. It also already runs automatically as part of `npm run dev` (reports issues but never blocks the watcher) and `npm run prod` (aborts the build if any lint error is found).
## To Do List
* Add mail frequency slider