OS Requirements

Please have the following installed on your system.

1. PHP v8.2.15
2. Composer v2.7.2
3. Node.js v18.19.1
4. Git v2.29.2

Setup

Make a local enviornment variable file

> cp .env.example .env

Install all required packages using composer using the following command.

> composer install

Install required packages using NPM using the following command.

> npm install

Generate a local environment key with the following command

> php artisan key:generate

Build front-end

> npm run build

Update the local database by running the migration with the following command.

> php artisan migrate

Starting the project

Backend

Start Laravel using the following command.

> php artisan serve

With your web browser you can view http://localhost:8000

Frontend (not required, for dev only)

Start React frontend using the following command. This allows front-end instant hot-module.

> npm run dev

Getting Started

1. You can create an account by registering (This will give you access to the platform).

2. After registering you can log into the platform and review the announcements by clicking announcements on the main menu.