|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Thanks for helping with Super Stack. |
| 4 | + |
| 5 | +## Setup |
| 6 | + |
| 7 | +1. Clone the repo and `composer install` |
| 8 | +2. Copy `.env.example` to `.env`, run `php artisan key:generate`, then `php artisan migrate` |
| 9 | +3. Create an admin user via the [Filament docs](https://filamentphp.com/docs/panels/installation#creating-a-user) |
| 10 | +4. For native work, follow [NativePHP Mobile v4](https://nativephp.com/docs/mobile/4/getting-started/installation) (`php artisan native:install`, then `php artisan native:run`) |
| 11 | + |
| 12 | +Herd tip: the app should be available at `http://superstack.test`. |
| 13 | + |
| 14 | +## What belongs where |
| 15 | + |
| 16 | +| Surface | Path | Ships on device? | |
| 17 | +| --- | --- | --- | |
| 18 | +| SuperNative screens | `app/NativeComponents`, `resources/views/native`, `routes/web.php` | Yes | |
| 19 | +| Filament admin | `app/Providers/Filament`, `/admin` | No (excluded in `config/nativephp.php`) | |
| 20 | +| MCP | `app/Mcp`, `routes/ai.php` | No | |
| 21 | +| Sanctum API | `routes/api.php`, `config/sanctum.php` | No (wired, not demoed) | |
| 22 | + |
| 23 | +Mobile bundle exclusions live in `nativephp.cleanup_exclude_files`. Do **not** exclude `vendor/*` packages from that list — stripping Composer packages after install breaks the on-device build. |
| 24 | + |
| 25 | +## Pull requests |
| 26 | + |
| 27 | +- Keep changes focused; prefer one concern per PR |
| 28 | +- Run `php artisan test` before opening a PR |
| 29 | +- Match existing code style (`pint` if you touch PHP) |
| 30 | +- Update the README when behavior or setup steps change |
| 31 | +- New NativePHP UI should use theme tokens (`text-theme-on-surface`, etc.) so light/dark both work |
| 32 | + |
| 33 | +## Reporting issues |
| 34 | + |
| 35 | +Include PHP / Laravel / NativePHP Mobile versions, platform (iOS/Android/web), and steps to reproduce. A simulator screenshot or log excerpt helps. |
| 36 | + |
| 37 | +## License |
| 38 | + |
| 39 | +By contributing, you agree your contributions are licensed under the MIT License (Copyright Bifrost Technologies LLC). |
0 commit comments