Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/RigbySawGame/ieeEdu_Wen/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through cloning the IEE Edu repository, installing all dependencies, and spinning up the full development environment — including the Laravel dev server, Vite HMR, and a background queue worker — so you can start contributing or exploring the platform in under ten minutes.

​
Prerequisites

Make sure the following tools are installed on your machine before you begin:
  • PHP 8.2+ with the sqlite3, pdo_sqlite, mbstring, openssl, and curl extensions enabled
  • Composer (latest stable)
  • Node.js 18+ and npm

​
Setup

1

Clone the repository

Clone the project from source control and enter the project directory.
git clone <repository-url> ieeEdu
cd ieeEdu
2

Install dependencies

Install both the PHP backend packages and the JavaScript frontend packages.
composer install
npm install
3

Set up the environment file

Copy the example environment file and generate a unique application key. The default configuration uses SQLite, so no database server is required for local development.
cp .env.example .env
php artisan key:generate
The .env.example ships with sane local defaults: DB_CONNECTION=sqlite, QUEUE_CONNECTION=database, CACHE_STORE=database, and MAIL_MAILER=log (mail output goes to storage/logs/laravel.log instead of being sent).
APP_NAME=Laravel
APP_ENV=local
APP_DEBUG=true
APP_URL=http://localhost

DB_CONNECTION=sqlite

QUEUE_CONNECTION=database
CACHE_STORE=database

MAIL_MAILER=log

IIE_WHATSAPP_SALES=51959166911
IIE_WHATSAPP_SUPPORT=51934057867

IIE_PLAN_TRIMESTRAL_PRICE=350
IIE_PLAN_SEMESTRAL_PRICE=600
IIE_PLAN_ANUAL_PRICE=990

EDUCATION_PASSING_SCORE=14
EDUCATION_MAX_ATTEMPTS=3
4

Set up the database

Create the SQLite database file, run all migrations, and optionally seed the database with sample data.
touch database/database.sqlite
php artisan migrate
php artisan db:seed
If you cloned the repo rather than using composer create-project, you must create the SQLite file manually with touch database/database.sqlite before running migrations.
5

Start the development server

The composer run dev script uses concurrently to start three processes in parallel with colour-coded output:
composer run dev
This single command expands to:
npx concurrently -c "#93c5fd,#c4b5fd,#fdba74" \
  "php artisan serve" \
  "php artisan queue:listen --tries=1" \
  "npm run dev" \
  --names='server,queue,vite'
ProcessPurpose
php artisan serveLaravel HTTP server on http://localhost:8000
php artisan queue:listen --tries=1Processes queued jobs (mail, notifications)
npm run dev (Vite)Frontend HMR with instant Vue component updates
6

Create an admin user

Use the built-in Artisan command to create or update a user with the admin role. The command accepts the email as a positional argument and --name / --password as options.
php artisan iie:make-admin [email protected] --name="Admin" --password=secret
If the email already exists in the database, the command performs an updateOrCreate — updating the name, password, and role without creating a duplicate record.
7

Open the application

Visit the application in your browser. Log in with the admin credentials you just created.
http://localhost:8000
If a frontend change is not reflected in the browser after editing a Vue component, run npm run build to force a fresh production build, or ensure composer run dev (which includes Vite’s HMR dev server) is still running.
Use php artisan route:list to inspect every named route registered in the application — including their HTTP methods, URIs, controller actions, and middleware. Combine with --except-vendor to filter out package routes, or --path=admin to focus on a specific prefix.
php artisan route:list --except-vendor

Build docs developers (and LLMs) love

Get started for freeTalk to us