SquadMS, or Squad Management System, is a Laravel based community and Squad server management system to accomodate all requirements set by OWI for licensed Squad server hosting and take the pain out of it.
Laravel has the most extensive and thorough documentation and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
If you don't feel like reading, Laracasts can help. Laracasts contains over 1500 video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
Requirements:
SquadMS coming with an Laravel Sail docker environment tailored to it's need. This environment does contain services for MySQL, Redis & HTTP as well as our SquadMS RCON Worker and has required software such as PHP and NodeJS/NPM installed to run the applications and development scripts.
In order to start using SquadMS you will first need to create your local environment configuration file by copying the .env.example file at the root of this project to .env. For now this will suffice.
Since Laravel Sail is installed using Composer it is required that you do install all dependencies before using Laravel Sail to run the development environment. Since Laravel Sail does require Docker to be installed we can use an intermediade container to do so as described in the offical documentation on how to install dependencies for existing projects - this will install all dependencies using Composer and NPM.
docker run --rm \
-u "$(id -u):$(id -g)" \
-v $(pwd):/var/www/html \
-w /var/www/html \
laravelsail/php81-composer:latest \
composer install --no-scripts --ignore-platform-reqs
It is advised that you then configure an bash alias for Laravel Sail. You can read on how to do so in the offical documentation. If you do wish to not use a bash alias you will have to substitute sail with vendor/bin/sail in the following steps.
After you have installed all dependencies using Composer and NPM you can use Laravel Sail to start the development environment as described in the documentation by running the following command:
sail up -d
It is highly recommended that you do read the offical documentation for Laravel Sail and Laravel for information on any further steps.
Now that your Laravel Sail environment is running you are able to use it to generate your APP_KEY in your .env file. To do so run the following command:
sail artisan key:generate
Next you will have to install and build the frontend assets using Laravel Mix. To do so simply run the following commands:
sail npm install
sail npm run dev
You will also have to publish all assets provided trought the SquadMS module system. This does include any theme or plugin. To do so run the following command:
sail artisan sqms:publish-assets
The first time you run SquadMS or after updating the application you will have to migrate changes to the databse scheme using the following command:
sail artisan migrate
Next you will need to add the following line to the hosts file:
127.0.0.1 squadms.local
The hosts file can be found at the following location for
- Linux
/etc/hosts - Mac OS
/private/etc/hosts - Windows
C:\Windows\System32\drivers\etc\hosts
You can now visit the followin URLs to view the local site:
https://squadms.local - The Octane version ("supercharged" but requires reload/reboot on changes)
https://squadms.local:8443 - The regular version (use this for xDebug as it is not compatible with Swoole)
SquadMS and the Laravel framework are open-sourced software licensed under the MIT license.