🌐 Website and API application powering the Beat Saber Server Browser mod (https://bssb.app)

This is the PHP source code powering the website and API that is used by BeatSaberServerBrowser.

• 📝 Receives and stores game information from players hosting matches
• 😎 Lets mod users browse and filter compatible and relevant games
• 🌐 Provides a public site where you can view games and stats

The easiest way to run the application is using Docker. You can use the provided docker-compose.yml file to set up the application.

• Docker
• Docker Compose

Clone the repository, then run the following command to start the application:

docker-compose up -d

You can set the following environment variables (in an .env file, or in your shell environment) to control the configuration of the application:

If you can't or don't want to use Docker, you can set up the application manually.

• Web server (recommended: nginx)
• PHP 8.4+ with extensions:
  • curl, dom, json, mbstring, pdo, xml
• Composer
• MySQL (or compatible) database
• Redis
• node-sass

Clone the repository (suggested path: /var/www/bssb.app) and install the dependencies with Composer:

composer install --no-dev

Configure nginx to direct all requests to public/index.php, example config:

server {
    server_name bssb.app;
    root /var/www/bssb.app/public;

    autoindex off;
    server_tokens off;

    index index.php;
    error_page 404 = /index.php;

    location / {
        try_files $uri $uri/ /index.php$is_args$args;
    }

    location ~ \.php$ {
        fastcgi_pass unix:/run/php/php8.3-fpm.sock;
        fastcgi_index index.php;
        include fastcgi.conf;
    }
}

Seed or migrate the database:

vendor/bin/phinx migrate

Create a config.php in the application root directory, using the provided config.sample.php as a template:

To enable cron jobs, by adding the following line to the crontab:

* * * * * cd /var/www/bssb.app && vendor/bin/crunz schedule:run

To generate stylesheets:

sass --update public/static/