A modern, community-driven hub for Quake III Arena Defrag enthusiasts.

About • Getting Started • Support Us • Contribution • License

✨ About

DeFRaG is a game mode within Quake III Arena that challenges players to complete levels as quickly as possible using advanced movement techniques like strafe-jumping and rocket-jumping to achieve the fastest times.

The goal of defrag.racing is to refresh the game by adding a modern and user-friendly UI, as well as introducing new features such as custom tournaments, rankings, clans, notifications and downloadable bundles with all necessary files to start playing DeFRaG as soon as possible.

🛠️ Getting Started

ℹ️ For Developers: See LOCAL_SETUP.md for detailed local development setup instructions.

ℹ️ For Production:

• Quick Start: Copy .env.example to .env and fill in credentials from PRODUCTION_CREDENTIALS.md
• Deployment Guide: See PRODUCTION_DEPLOYMENT.md for complete setup
• Credentials: See PRODUCTION_CREDENTIALS.md (local file, not in git) for Backblaze B2 keys, DB passwords
• Storage Options: PRODUCTION_STORAGE.md | PRODUCTION_STORAGE_CONTABO.md

⚠️ SECURITY: .env and PRODUCTION_CREDENTIALS.md contain secrets and are in .gitignore. Never commit them to GitHub!

⚠️ Important Notice: The installation steps provided in this guide have only been tested on a Linux machine. They are not thoroughly tested and are primarily intended as a kickstart for development. If you encounter any issues or if you have a better solution, we warmly invite you to contribute to this repository. Your contributions are highly appreciated!

⚠️ Important Notice: The following steps are designed to work with Docker, utilizing a Laravel tool called Sail. However, it's important to be aware that the production server operates on a non-containerized approach at the moment.

Prerequisites

To clone and run this application, you'll need:

• Git
• Docker
  • Configure Docker to start on boot
  • Add user to docker group
• PHP:
  • You php and some extenstions:
    • php
    • php-curl
    • php-zip
    • php-xml
    • php-intl
  • In PHP .ini file you may need to uncomment extenstions:
    • filetype
    • zip
• Composer

Installation

1. Clone the repository:

   • Using HTTPS:

     git clone https://github.com/neyoneit/defrag-racing-project.git

   • Using SSH:

     git clone git@github.com:neyoneit/defrag-racing-project.git

2. Enter the repository:

   All below commands assume you are in project's top level directory. Enter it with:

   cd defrag-racing-project

3. Run startup script:

   Script below contains all steps to setup, install and start local server.

   ./local_devel/start_local_server.sh

4. Go to localhost

5. (Optionally) Load up dummy data:

   You can load dummy data into your local environment using the following command:

   ./local_devel/load_dummy_data.sh

   The dummy SQL database includes an admin user with the following credentials:

   login: admin
   password: password
   

   After logging in, you can access the dashboard at localhost/defraghq.

6. To stop the server run:

   ./vendor/bin/sail stop

Database Migrations

When working with database schema changes, always use Laravel migrations instead of manual SQL:

1. Creating a new migration:

   docker compose exec laravel.test php artisan make:migration migration_name

2. Running migrations:

   docker compose exec laravel.test php artisan migrate

3. After pulling new migrations from git:

   docker compose exec laravel.test php artisan migrate
   ./rebuild-frontend.sh

⚠️ IMPORTANT: Never alter database tables directly using SQL commands. Always create proper migration files using php artisan make:migration to ensure consistency between development and production environments.

❤️ Support Us

We hope you've enjoyed using using defrag.racing.

If you'd like to contribute to the ongoing development and maintenance of this project, as well as our other initiatives like defraglive and demome, please consider making a donation.

You can do so through .

Your support allows us to continue improving these projects for the benefit of all Defragers. Thank you!

🤝 Contribution

Even if you're not a developer, there are numerous ways you can contribute to this project. Please see the CONTRIBUTION guide for more information on how you can help.

Thank you for considering contributing to defrag.racing. We appreciate it! ❤️

📜 License

This project is licensed under the GNU Affero General Public License v3 (AGPLv3), which applies to all past and future contributions.

---

defrag.racing  ·  discord  ·  youtube  ·  twitch