Skip to content
Sharkhex

Sharkhex Sports

Documentation

Everything to install, run and extend Sharkhex Sports.

Getting started

  • Product overview

    What Sharkhex Sports is, what comes with a license, and where to start.

  • Installing

    A server with or without Docker, bin/new-instance, the installer's seven steps, and what to check before your first players arrive.

  • Configuring

    What lives in .env.local and what in the admin's Settings: each screen, the organisation type, languages and time zones.

  • Scheduled jobs and backups

    The crontab, nightly backups, restoring one, and the background queue.

  • Upgrading

    Taking a new release with bin/upgrade, going back, and backups by hand.

Running the platform

  • The website

    The public website: its brand, the home page, competition pages, entering a team, menus and languages.

  • Payments

    Stripe, NETOPIA and PayPal; fees, refunds, receipts and VAT, memberships, and payouts to venues and clubs.

  • Data sources

    Fixtures, results and teams from a federation, a spreadsheet or a calendar.

  • Open matches

    Players offering a free court slot to others of their level; the court is booked once the match is full.

  • Privacy and GDPR

    The privacy policy and the terms filled from your settings, the processing record, how long data is kept, people's requests, and consent to news and offers.

  • Secret settings

    How the admin's secret settings are sealed, and changing their key.

  • Live scoring and statistics

    Captains keeping the score as a match is played, the website following it, and statistics for players, teams and competitions.

  • Cricket and baseball

    Cricket's innings, the league's points and bonus points and net run rate; baseball and softball tables by win percentage.

Apps and clients

  • Your brand

    The apps' identity in one brand.json: applying it, checking it, and starting a new brand.

  • Building and publishing the apps

    Signing, push notifications, the Brand build workflow, building on your own Mac or with EAS, and updates without a store review.

Developers

  • Public API and widget

    Reading fixtures and tables from other websites and tools, with API keys, and the widget for clubs' own sites.

  • Writing a data source

    Connecting the platform to a federation, a booking system or another league's software.

Found a mistake? Tell us.