ONSDave24

Overview

DAVE is the Daily Attendance & Validation Engine, a Laravel application to allow employees to track their working hours.

Run Locally (Laravel Sail)

Clone the project

git clone https://github.com/angus-websites/ONSDave24.git

Go to the project directory

cd ONSDave24

Setup Laravel Sail

NOTE: Ensure you have Docker installed

docker run --rm \
    -u "$(id -u):$(id -g)" \
    -v $(pwd):/var/www/html \
    -w /var/www/html \
    laravelsail/php81-composer:latest \
    composer install --ignore-platform-reqs

Generate a .env file

cp .env.example .env

Run Laravel Sail (Development server)

TIP: Add ./vendor/bin/sail as an alias to sail on your machine to make this command easier to run

./vendor/bin/sail up

Open a new Terminal tab in the same project root folder

Generate an app encryption key

./vendor/bin/sail php artisan key:generate

Migrate the database

./vendor/bin/sail php artisan migrate

Seed the database

./vendor/bin/sail php artisan db:seed

Install NPM dependencies

./vendor/bin/sail npm i

Run Vite

./vendor/bin/sail npm run dev

Visit Localhost

New version of ONSDave written in Laravel 11

Setting up PHPStorm php interpreter

1. Go to Settings > PHP > Test Frameworks
2. Click on + and select PHPUnit by Remote Interpreter
3. Click on ... next to "CLI Interpreter"
4. Click on + and select From Docker, Vagrant, VM, WSL, Remote...
5. Select Docker Compose
6. Select Service as laravel.test
7. Click Apply and OK
8. In the PHHPUnit Library section ensure the "Path to script" is set to /var/www/html/vendor/autoload.php
9. Click Apply and OK

Setting up PHPStorm Xdebug

1. Ensure the SAIL_XDEBUG_MODE=develop,debug,coverage is set in the .env file