/RAWeb

RetroAchievements.org

Primary LanguagePHPGNU General Public License v3.0GPL-3.0

RAWeb

RAWeb is RetroAchievements.org's site and server backend. It is a "flat" PHP project; individual php files within the public folder handle server requests.

Requirements

XAMPP provides an easy way to run an Apache web server, MySQL/MariaDB, and PHP on your system.

Note: Install the XAMPP version packaged with PHP 7.4.

You might have to enable some extensions in php.ini:

extension=curl
extension=mysqli
extension=pdo_mysql

Alternatively, Docker Compose can be used to run MySQL and PHPMyAdmin. See docker-compose.yml for details. Follow the .env file instructions below to configure your environment, then run:

$ docker-compose up -d

Setup

After installing all required software the site needs to be configured for your local needs. The environment configuration file (.env) contains a sensible set of default values.

  1. Copy .env.example to .env.

    Linux/MacOS:

     $ cp .env.example .env

    Windows:

     $ copy .env.example .env

  2. Adjust the contents of .env to match your local setup:

    • Enter the credentials of you local database instance (DB_*).
    • URL to where index.php can be found (APP_URL).
    • URL to where static assets, like images, are stored (APP_STATIC_URL). Most likely the same as APP_URL in a local environment.

  3. Add image assets:

    Download the media archive and add its files to the respective folders in public.

  4. Install dependencies:

    Use composer provided in this repository...

     $ php composer.phar install

    ...or your globally installed instance.

     $ composer install

  5. Build the dummy database using the SQL commands in the /database folder. You can use the MySQL CLI (recommended) or the phpMyAdmin GUI.

  6. Copy releases.dist.php to releases.php in lib/database:

    Linux/MacOS:

     $ cp lib/database/releases.dist.php lib/database/releases.php

    Windows:

     $ copy lib\database\releases.dist.php lib\database\releases.php

  7. Open the application in your browser.

Contributing

See the Contribution Guidelines.

License

RAWeb is open-sourced software licensed under the GPL-3.0 License.