Getting Started

[TheRefraction]

Getting Started

The following tutorial explains how to get started with this project.

Installation

Windows

Requirements

• WSL 2
• Docker Desktop
• Git

Install WSL

1. Make sure hardware virtualization support is enabled in your BIOS
2. Run the following command in PowerShell as Administrator wsl --install and restart your computer.
   Please make sure the following Windows features are being installed:
   • Virtual Machine Platform
   • Windows Subsystem for Linux (WSL)
3. Install a Linux distro using the following command wsl --install [Distro] where [Distro]
   is the name. To view all distributions available for download, enter wsl --list --online
4. Configure the Linux distro you chose by supplying a UNIX login and update the system

Install Docker Desktop

1. Download the Docker Desktop installer either from the official Docker website
   or using winget (Windows Package Manager) in PowerShell winget install Docker.DockerDesktop.
2. On the setup screen, please ensure you select Use WSL 2 instead of Hyper-V
3. When starting Docker for the first time, accept the subscription service agreement.
   You do not need to create an account, working locally is enough
4. Finally Docker will initialize. This may take a few minutes on first launch

Install Git

Download the installer either from the official Git website
or using winget in PowerShell winget install Git.Git.

Linux

TODO

Project Setup

1. Clone the repo: git clone https://github.com/TheRefraction/WE4_Project.git
   and open it in your IDE
2. Copy the env file example .env.example to .env and fill in your values.
   This file should NEVER be committed to GitHub
3. Start containers by running the manage start script. This may take a while the first time

Note

Windows users may have trouble to run the PowerShell script if the execution policy is not set accordingly.
Please keep in mind that this may pose a security threats and remember to never run any unknown scripts.

5. Open http://localhost:8080 to view the website

Database Link Configuration

1. In your IDE, find and open the Database panel/view
2. Click on the + icon and select MySQL data source
3. Set host to localhost, port to 3306, and provide login information
   as well as the database name
4. Install drivers if prompted
5. Test the connection and save

You may now view the database within your IDE.

Useful Notes

If you have configured everything correctly, you should have Connected to MySQL successfully!
appear on the index.php page.

Modifying the .env file

• You may define a user login and a root password. The latter should not be empty for security
  reasons
• You may define a database that will be created and populated accordingly.

Local URLs

• Open http://localhost:8080 to access the current website. All modifications
  made to the files are reloaded when refreshing the page in your
  Internet browser
• Open http://localhost:8081 to access PhpMyAdmin. You may access
  the dashboard by providing root as a username and the root password you
  defined in your .env file.
• Sometimes albeit rare, a computer may fail to resolve localhost. Should that happen,
  please replace any occurrence of localhost by 127.0.0.1.