Skip to content
Sharkhex

Sharkhex Delivery

Documentation

Everything to install, run and extend Sharkhex Delivery.

Getting started

  • Product overview

    The roles of the platform, what customers, vendors, riders and administrators do in it, and how the mobile app talks to the backend.

  • Docker deployment

    Run one instance on one server with the backend's Docker setup: what runs, the first start, updates and backups.

  • Backend installation

    Install the Symfony backend by hand: server requirements, dependencies, environment, JWT keys, the database and the first admin user.

  • Installer and updates

    The browser installer at /install and the admin update page at /admin/updates: what each one checks, asks for and changes.

  • Scheduled jobs

    The console commands to run on a schedule and what breaks without them, a crontab, how payout runs pay riders and vendors, and the optional background queue.

  • Deployment checklist

    What to check before going live: the backend, caching, the mobile release, store submission and security.

Running the platform

  • Platform configuration

    The settings in the admin panel: platform, currency, sign-in security, storage, integrations, payments, commission and tax, delivery zones and fees, and the website.

  • Admin and vendor panels

    The main admin panel and the vendor panel: live ops, reports, refunds and credit, stores, menus and promotions, couriers, sign-in, the partner API, account deletion and legal documents.

  • Payments

    Stripe in the backend and the app, the webhook, the customer and saved card flows, paying riders and vendors, and receipts, invoices and credit notes.

  • Troubleshooting

    Common problems and their fixes: the local server, JWT sign-in, admin and vendor access, the app's backend URL, Stripe, Pusher, Google Maps, uploads and stale assets.

Apps and clients

  • Mobile app setup

    The Expo app: requirements, the brand manifest and backend URL, links that open the app, builds, over-the-air updates, crash reports, analytics, accessibility and the white-label rules.

  • New client instance

    The repeatable path to stand up a client's own instance: the accounts they own, the backend, the app, store submission and updates.

Developers

  • API and integrations

    The API of the app and of integrations: authentication and sign-in codes, Google Maps, Pusher, mail, search, stores and couriers, the partner API and webhooks, the website and caching.

Found a mistake? Tell us.