Kickback Kingdom Website

This repository houses the code for the Kickback Kingdom website:

https://www.kickback-kingdom.com/

Caveats

At the moment, this repository might not contain everything needed to run the website locally or create your own instance. To do that, you would need these things:

• A database populated with at least an admin account, and some other essential records.
• Ideally, image files for the webpages. (It seems to work without them, but doesn't look like the real thing.)

This repository DOES contain an SQL schema for the database, it just might not have minimally viable data to go with it. (We are keeping the website's current database private for security reasons, but providing a minimal database for testing/dev purposes is something we want to do in the future.)

The images are currently stripped out of the repository because they required 300+MB and were a bit much. And because the website installs into an html/htdocs folder AND creates a "beta" copy in its beta subfolder, it would occupy 600MB+ after everything is duplicated. There are even bigger issues with uploaded content being mixed with static assets, which are things we need to resolve before image files can be hosted in the site's git repository. So all of these things are a work-in-progress, and we hope to eventually have images available at some point, either by adding the static assets to the git repository, or providing an external download and configuration options in the website.

In spite of these caveats, this repository should still be very useful: it will allow anyone to see how scripts work on the website, make pull requests, submit bug reports, request features, and so on.

Of course, there has been some evidence to suggest that it might work anyways. It will probably load pages, but it won't look exactly like the public website (due to missing assets and missing database entries).

Installation

Below are some instructions for setting up a minimal copy of the server.

Dependencies:

• Apache/HTTPD webserver
• MySQL/MariaDB database
• PHP version 8.2 or greater
• PHP Composer
• OS:
  • Linux (tested on both Gentoo Linux and Amazon AWS; works well)
  • Windows (works well with XAMPP)
  • It can probably work in any other environment where the aforementioned Apache+MySQL+PHP+... are available.

Steps:

1. Have the above dependencies met on the system the site is being installed to.
2. Set up the MySQL server to have a user account that the Kickback Kingdom website can log in to.
3. Upload the SQL schema from the kickback-kingdom-website/schema/kickback-kingdom-schema.mysql into the MySQL server.
4. (WIP/TODO: Right now this step is not possible to do.) Add an admin account to the website, and any other records needed for it to function.
5. Create a "service credentials" config file in either /srv/kickback-kingdom/credentials.ini or /etc/kickback-kingdom/credentials.ini.
6. Fill the credentials.ini file with the necessary SQL account information (username+password+etc) and SMTP server information (username+password+etc, for "forgot password" feature).
   • See kickback-kingdom-website/html/service-credentials-ini.php for details about what fields are needed in the .ini file. (This path may change soon as the config file code gets refactored.)