SwiftRPG

Setting up a Development Environment (in WSL/Ubuntu)

Dependencies

git

First, clone the other required services:

https://github.com/SwiftIRC/SwiftRPG https://github.com/SwiftIRC/SwiftRPG-map

We will become root for the rest of this work.

sudo -i

packages

Second, add the PHP repository to your apt sources:

NOTE: This command is for Ubuntu 20.04

echo "deb http://ppa.launchpad.net/ondrej/php/ubuntu focal main" > /etc/apt/sources.list.d/ondrej-ubuntu-php-focal.list
apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 4F4EA0AAE5267A6C
apt update

Third, install the following packages:

NOTE: php8.1-fpm and nginx are optional (more information below)

sudo apt install php8.1-fpm php8.1-mysql php8.1-gd php8.1-mbstring php8.1-xml php8.1-curl php8.1-zip mysql-server mysql-client nginx

This will install PHP 8.1, MySQL 8.0, and nginx 1.18.0.

NOTE: You may need to install openssl here if it's not already installed

mysql

Now we're going to configure MySQL to create a user and a database:

mysql
create user 'rpg'@'localhost' identified by 'password';
create database rpg;
grant all on rpg.* to 'rpg'@'localhost';
flush privileges;

nginx (optional)

Getting nginx configured can be tricky.

First, we can rm the default host configuration and touch the new one.

rm /etc/nginx/sites-enabled/default
touch /etc/nginx/sites-enabled/rpg.swiftirc.dev

Let's edit that new file with your favorite editor to contain the following:

server {
    server_name rpg.swiftirc.dev _;
    root /home/rohara/Workspace/personal/SwiftRPG-web/public;
    listen 80;
    server_tokens off;

    client_max_body_size 50m;

    location ~ ^/dist/.* {
       root /home/rohara/Workspace/personal/SwiftRPG-map;
       index index.html;
    }

    location ~ ^/map {
       root /home/rohara/Workspace/personal/SwiftRPG-map;
       rewrite ^/map/?(.*) /dist/$1 break;
    }

    index  index.php index.html index.htm;
    location ~ \.php {
        include         fastcgi_params;
        fastcgi_index   index.php;
        fastcgi_pass    unix:/var/run/php/php8.1-fpm.sock;
        fastcgi_param   SCRIPT_FILENAME    $document_root$fastcgi_script_name;
        fastcgi_param   SCRIPT_NAME        $fastcgi_script_name;
        fastcgi_intercept_errors on;
    }

    location / {
        index index.php;
        try_files $uri $uri/ /index.php?$query_string;
    }
}

/etc/hosts (optional)

Add 127.0.0.1 rpg.swiftrpg.dev to your /etc/hosts file. In Windows this requires running Notepad as an administrator and editing C:\Windows\System32\drivers\etc\hosts. If you do not see that file in the list, be sure to select All Files from the dropdown at the bottom right of the Open menu.

.env

You may now exit the root shell with exit or ctrl+d.

Next, copy the .env file, generate a key, and make any modifications you may need:

cp .env.example .env
php artisan key:generate

php

Now we can install our PHP dependencies:

composer install

NOTE: If you do not have composer installed, please make the utility available in your $PATH as composer after referencing their docs here: https://getcomposer.org/download/

npm

Run the following to install npm resources and to build JS & CSS resources:

npm install
npm run build

To enable hot reloading, run the development server:

npm run dev

Run Migrations

php artisan migrate --seed

Load it in Your Browser

Option 1: nginx

Open up your new development environment!

http://rpg.swiftirc.dev/
http://rpg.swiftirc.dev/map

Option 2: Development Servers

Run the following commands:

npm run dev &
php artisan serve

Open up http://127.0.0.1:8000 in your browser

NOTE: This will enable hot-reloading. Modifying JavaScript or CSS will automatically refresh the page.