Installation & Setup - IzzatFirdaus/uma_musume_race_planner GitHub Wiki

Follow these steps to get the Uma Musume Race Planner running on your local development environment.

Prerequisites

  • A local web server environment (e.g., XAMPP, WAMP, MAMP, or a Docker setup).
  • PHP 8.0 or higher.
  • MySQL or MariaDB database server.
  • Composer for managing PHP dependencies.

1. Clone the Repository

Clone this repository to your local machine, typically inside your web server's root directory (e.g., htdocs for XAMPP).

git clone [https://github.com/IzzatFirdaus/uma_musume_race_planner.git](https://github.com/IzzatFirdaus/uma_musume_race_planner.git)
cd uma_musume_race_planner

2. Install Dependencies

The project uses Monolog for logging. Install it using Composer.

composer install

3. Database Setup

  1. Create the Database: Using a tool like phpMyAdmin or the command line, create a new database. The default name is uma_musume_planner.

    CREATE DATABASE IF NOT EXISTS `uma_musume_planner`;

  2. Import the Schema: Import the database structure by executing the uma_musume_planner.sql file. This will create all the necessary tables and relationships.

  3. Seed with Sample Data (Optional): To populate the application with sample data for testing, import the sample_data.sql file.

    Warning: This script will delete all existing data in the plan-related tables before inserting new records.

4. Environment Configuration

  1. Create a .env file: In the root directory of the project, create a file named .env.

  2. Configure Database Credentials: Copy the contents from the .env.example file (if available) or add the following, adjusting the values to match your local database setup. The db.php script will read this file.

# .env - Local Development Configuration

# Database Configuration
DB_HOST=localhost
DB_NAME=uma_musume_planner
DB_USER=root
DB_PASS=

# Application Metadata & Theming
APP_VERSION=v1.4.0
APP_THEME_COLOR=#7d2b8b
LAST_UPDATED="July 29, 2025"

5. Running the Application

Navigate to the project directory in your web browser (e.g., http://localhost/uma_musume_race_planner/). The application should now be running.