Download the PHP package zeeplabs/orbit-client without Composer
On this page you can find all versions of the php package zeeplabs/orbit-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download zeeplabs/orbit-client
More information about zeeplabs/orbit-client
Files in zeeplabs/orbit-client
Download zeeplabs/orbit-client
More information about zeeplabs/orbit-client
Files in zeeplabs/orbit-client
Vendor zeeplabs
Package orbit-client
Short Description PHP client for Zeep Orbit β auto-generated REST APIs for your apps
License
Package orbit-client
Short Description PHP client for Zeep Orbit β auto-generated REST APIs for your apps
License
Please rate this library. Is it a good library?
Informations about the package orbit-client
--- **Zeep Orbit** is an open-source, self-hosted BaaS (Backend-as-a-Service) platform. It turns a simple schema definition into instant REST APIs + PostgreSQL schemas β designed for AI-generated frontends (Claude Code, Cursor, Lovable, v0) that need a backend without building one from scratch.--- ## π Index - [Features](#-features) - [Quick start](#-quick-start) - [Docker](#docker-compose) - [Kubernetes (Helm)](#kubernetes-helm) - [Binary](#binary) - [Dashboard](#%EF%B8%8F-dashboard) - [Configuration](#-configuration) - [Environment variables](#environment-variables) - [apps.yaml](#appsyaml) - [Authentication](#-authentication) - [REST API](#-rest-api) - [SDK Clients](#-sdk-clients) - [CLI](#-cli) - [Observability](#-observability) - [Deployment](#-deployment) - [Docker](#docker) - [Kubernetes (Helm)](#kubernetes-helm-1) - [Roadmap](#%EF%B8%8F-roadmap) - [Development](#%EF%B8%8F-development) - [Contributing](#-contributing) - [License](#-license) --- ## β¨ Features | Feature | Description | | ---------------------- | -------------------------------------------------------- | | **Schema β REST** | Define tables in YAML or Dashboard UI β instant CRUD API | | **Web Dashboard** | Premium dark UI to manage apps, tables, data, users | | **Auth by Email** | Built-in email/password register & login per app | | **Google OAuth** | Sign in with Google β both dashboard and per-app | | **Row-Level Security** | Auto-filter data by owner (`rls: owner`) | | **Per-App Health** | `GET /{app}/health` for monitoring and readiness probes | | **Soft Delete** | Configurable soft delete toggle (dashboard settings) | | **CORS** | Cross-origin support for SPAs and mobile apps | | **OpenAPI Docs** | Auto-generated Swagger UI per app | | **Data Browser** | GUI to browse, filter, edit, export CSV, delete rows | | **User Management** | Manage dashboard admins and app users | | **Audit Logs** | Action history with filters (who did what, when, IP) | | **File Storage** | Per-app S3-compatible storage (DO Spaces, AWS, MinIO) | | **Rate Limiting** | Per-app, per-IP sliding window (configurable RPM) | | **White-label** | Custom branding, themes, company name | | **Prometheus Metrics** | `zeep_http_requests_total`, latency histograms | | **Multi-app** | One service, N apps, isolated schemas & JWT secrets | | **CLI** | `zeep serve`, `zeep apply`, `zeep list`, `zeep status` | | **Kubernetes** | Production-grade Helm chart (HPA, PDB, ingress, IRSA) | | **SDK Clients** | TypeScript, Go, Python, Rust, Java, PHP | | **i18n** | Dashboard in pt-BR / English, language switcher | --- ## π Quick start ### Docker Compose > **Note:** If PostgreSQL is running on the host machine (not in another container), use `host.docker.internal` instead of `localhost` in `DATABASE_URL`. Then visit **http://localhost:8080/dashboard** to complete the first-time setup. ### Docker Compose Create a `docker-compose.yml`: ### Quick start with Docker ### Binary ### Kubernetes (Helm) β See the [Kubernetes (Helm)](#kubernetes-helm-1) section under **Deployment** for a full guide with all options. --- ## π₯οΈ Dashboard The web dashboard is embedded in the binary and accessible at `/dashboard`. Features: - **Apps** β create, edit, delete apps with dynamic table/column management - **Data Browser** β browse, filter, sort, edit inline, delete, and export CSV - **Users** β manage dashboard admins (superadmin/admin roles) - **App Users** β view users registered in each app, deactivate accounts, reset sessions - **Logs** β real-time request log with metrics breakdown - **Audit** β action history with user, action type, resource, IP, and pagination - **Settings** β white-label branding (themes, company name), Google OAuth configuration - **i18n** β dashboard available in pt-BR and English, language switcher in sidebar --- ## π Configuration ### Environment variables | Variable | Required | Description | | ---------------------------- | -------- | --------------------------------------------------- | | `DATABASE_URL` | β | PostgreSQL connection string | | `DASHBOARD_BOOTSTRAP_SECRET` | β | First-time admin setup secret | | `GOOGLE_CLIENT_ID` | β | Google OAuth Client ID (for dashboard login) | | `GOOGLE_CLIENT_SECRET` | β | Google OAuth Client Secret | | `GOOGLE_REDIRECT_URL` | β | Google OAuth redirect URL | | `GOOGLE_ALLOWED_DOMAINS` | β | Comma-separated allowed email domains | | `BRAND_THEME` | β | Default theme (azure, emerald, ruby, amber, orange) | | `BRAND_COMPANY_NAME` | β | Company name for white-label | | `LOG_LEVEL` | β | Set `debug` for development output | | `DASHBOARD_LOG_BUFFER_SIZE` | β | Ring buffer size for log viewer (default: 2000) | ### apps.yaml ### Column types `text`, `integer`, `bigint`, `decimal`, `boolean`, `uuid`, `timestamptz`, `jsonb` Options: `required` (NOT NULL), `unique`, `default` (SQL expression). Auto-generated columns: `id` (UUID), `created_at`, `updated_at`, `deleted_at` (nullable, used when soft delete is enabled). --- ## π Authentication ### App-level (for your end-users) Each app supports configurable login providers: | Provider | Endpoint | Description | | -------- | ------------------------------ | ------------------------------ | | Email | `POST /{app}/auth/register` | Register with email + password | | Email | `POST /{app}/auth/login` | Login with email + password | | Google | `GET /{app}/auth/google/login` | Sign in with Google | | All | `GET /{app}/auth/providers` | List enabled providers | After authentication, you receive a JWT token signed with the app's secret. ### Dashboard (admin access) Dashboard has its own auth system (email/password or Google OAuth), separate from app auth. Two roles: `admin` and `superadmin`. --- ## π‘ REST API | Method | Path | Description | | --------- | --------------------- | ---------------------------------- | | GET | `/{app}/{table}` | List (paginated, filtered, sorted) | | POST | `/{app}/{table}` | Create | | GET | `/{app}/{table}/{id}` | Get by ID | | PUT/PATCH | `/{app}/{table}/{id}` | Update (partial) | | DELETE | `/{app}/{table}/{id}` | Delete (soft-delete if enabled) | | GET | `/{app}/health` | Per-app health check (no auth) | | GET | `/health` | Global health check | | GET | `/metrics` | Prometheus metrics | | GET | `/docs/{app}` | Swagger UI | | GET | `/{app}/auth/*` | Auth endpoints | | POST | `/{app}/files` | Upload file (multipart) | | GET | `/{app}/files` | List files | | GET | `/{app}/files/{id}` | Get file metadata | | GET | `/{app}/files/{id}/download` | Download file (302 β signed URL) | | GET | `/{app}/files/{id}/url` | Get signed URL with TTL | | DELETE | `/{app}/files/{id}` | Delete file | Query params for list: `?limit=`, `?offset=`, `?field=eq.value`, `?order=field.asc`, `?deleted=true` (show soft-deleted records when soft delete is enabled) --- ## π¦ SDK Clients Official clients for all major languages. Same API across all: | Language | Package | Path | |---|---|---| | TypeScript | `@zeeptech/orbit-client` | `clients/typescript/` | | Go | `github.com/zeeplabs/orbit-go` | `clients/go/` | | Python | `zeeplabs-orbit-client` | `clients/python/` | | Rust | `orbit-client` | `clients/rust/` | | Java | `com.zeeplabs:orbit-client` | `clients/java/` | | PHP | `zeeplabs/orbit-client` | `clients/php/` | --- ## π§ CLI Example: --- ## π Observability - **Prometheus metrics** at `/metrics`: request count, latency, active apps - **Structured JSON logging** via `zap` (set `LOG_LEVEL=debug`) - **Dashboard logs** with real-time ring buffer, metrics, and app-level filtering --- ## π³ Deployment ### Docker ### Kubernetes (Helm) The Helm chart includes: HPA, PDB, Ingress, ServiceMonitor, IRSA-ready ServiceAccount, topology spread, and configurable resource limits. > β οΈ **Important:** The `zeep serve` command **does not use a config file**. It loads everything from the database. Apps are created and managed through the Dashboard at `/dashboard`. For a standard deployment, **all you need is the database**. #### Dashboard-only β manage apps through the UI The minimum required to run: 1. Install with Helm 2. Access `https://your-domain/dashboard` 3. Use the `dashboardBootstrapSecret` in the bootstrap form 4. Create admin users and apps through the interface Apps created in the Dashboard persist in the database and are automatically loaded on every restart. #### Env var flow The chart uses **2 mechanisms** to inject env vars into the pod: #### Full example (dashboard + pre-defined apps + Google OAuth + storage) Install: After deployment, go to `/dashboard`, bootstrap with the `dashboardBootstrapSecret`, and create your users and apps β all through the interface. #### Upgrading To upgrade an existing Helm release: The `--atomic` flag rolls back automatically if the upgrade fails. Always keep your `values.yaml` backed up β it contains your database URL and secrets. --- ## πΊοΈ Roadmap | Milestone | Status | Features | |---|---|---| | **M1 β MVP Core** | π’ Done | Schema β REST, CLI, Docker Compose | | **M2 β Dashboard** | π’ Done | App CRUD, Data Browser, Logs, Users, Auth, White-label | | **M3 β Governance** | π΅ In progress | β Audit Log Β· β¬ RBAC Β· β¬ SSO | | **M4 β Storage & Events** | π΅ In progress | β S3/File Storage Β· β¬ Webhooks Β· β¬ Event Bus | | **M5 β i18n** | π’ Done | pt-BR / English, language switcher | | **M6 β SDKs** | π’ Done | TS, Go, Python, Rust, Java, PHP clients | | **M7 β AI Schema** | π΅ In progress | β Natural language table creation via AI | ### Deferred / Backlog - Sign in with Apple (per-app) - TypeScript SDK code generator (`@zeeptech/orbit-generate`) - MCP server for zeep-orbit - GraphQL auto-generation - Realtime subscriptions (WebSockets) - Edge functions - Schema change approval workflow - Marketplace of app templates --- ## π οΈ Development Integration tests require PostgreSQL: ### Project structure --- ## π€ Contributing See [CONTRIBUTING.md](CONTRIBUTING.md). All contributions welcome β bug fixes, features, docs, tests. --- ## π License MIT β see [LICENSE](LICENSE). --- ## π’ About Zeep Tecnologia zeep-orbit was created by [Zeep Tecnologia](https://zeeptecnologia.com.br) to solve a real pain we saw everywhere: small businesses, entrepreneurs, and indie developers using AI tools (Claude Code, Cursor, Lovable, v0) to build frontends in minutes β but getting stuck when they need a backend. Spin up a database, write migrations, deploy an API, manage auth, handle secrets β it kills the momentum. And the alternative (Supabase, Firebase) sends your data outside your infrastructure. zeep-orbit is our answer: **one binary, your PostgreSQL, infinite apps.** Deploy inside your own infra, connect any frontend, move fast without the backend overhead. We build open-source infrastructure for the AI era. [Join us](https://github.com/zeeplabs/zeep-orbit/discussions).
All versions of orbit-client with dependencies
PHP Build Version
Package Version
Requires
php Version
>=8.1
ext-curl Version *
ext-json Version *
ext-curl Version *
ext-json Version *
The package zeeplabs/orbit-client contains the following files
Loading the files please wait ...