ngo-tools/sdk-laravel-starter

Laravel Starter Package for building NGO.Tools extensions

Maintainers

Package info

github.com/ngo-tools/sdk-laravel-starter

pkg:composer/ngo-tools/sdk-laravel-starter

Statistics

Installs: 39

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

v0.8.5 2026-04-02 15:26 UTC

This package is auto-updated.

Last update: 2026-04-02 20:05:09 UTC


README

Laravel package for building NGO.Tools extensions.

Quick Start

The easiest way to get started is via the NGO.Tools admin panel:

  1. Go to Apps in your NGO.Tools panel
  2. Click App erstellen, enter a name
  3. Run the generated command in your terminal

This will create a Laravel project, install this package, and connect your app automatically.

Manual Installation

composer require ngo-tools/sdk-laravel-starter
php artisan ngotools:install

Commands

Command Description
php artisan ngotools:install Interactive setup wizard (UI slots, webhooks, scopes)
php artisan ngotools:dev Start dev server + cloudflared tunnel
php artisan ngotools:sync Push manifest changes to NGO.Tools

Configuration

After installation, configuration is in config/ngotools.php and .env:

NGOTOOLS_API_URL=https://your-org.ngo.tools
NGOTOOLS_DEV_TOKEN=...
NGOTOOLS_WEBHOOK_SECRET=...
NGOTOOLS_PORT=8001

UI Slots

Extensions can integrate into these UI slots:

  • Navigation Entry — Full-page iframe under a navigation link
  • Dashboard Card — Widget card on the dashboard
  • Contact Tab — Tab on the contact detail page

Views are published to resources/views/vendor/ngotools/pages/.

Webhooks

When you select webhook events during setup, the package generates:

  • routes/ngotools-webhooks.php with a webhook handler
  • HMAC-SHA256 signature verification middleware

Manifest

The app manifest is generated at .well-known/ngotools.json and served automatically. Edit it manually or re-run php artisan ngotools:install to regenerate.

License

MIT