XCodeSol School Management Suite Documentation

Installation

Requirements

  • PHP 8.2 or newer.
  • MySQL 8.0 or newer.
  • Apache with .htaccess and mod_rewrite enabled.
  • A domain or subdomain pointed to the hosting public_html directory.
  • Ability to create a MySQL database and database user.
  • ZIP upload and extraction access through hosting file manager, FTP, or SSH.

Installable Package

The buyer package is generated from the app repository as:

text
release/xcode-school-mgmt-installable.zip

The ZIP stages the application as public_html, includes the compiled frontend, includes the PHP API, and ships the database schema and migrations needed by the installer.

Browser Installer

1. Upload and extract the installable ZIP into the target domain public_html directory. 2. Open the domain in a browser. 3. The installer runs until storage/installed.lock exists. 4. Enter database host, database name, database user, password, school details, and administrator details. 5. Submit the form. 6. The installer imports database/schema.sql, applies database/migrations, writes backend/.env, updates the seeded school and administrator, creates the install lock, and opens the app.

First Login

Use the administrator email and password entered during installation. After login, open Settings to review school profile, language options, active modules, mail settings, SMS gateway settings, roles, and permissions.

Local Developer Setup

Database:

powershell
powershell -ExecutionPolicy Bypass -File scripts\database.ps1 -Action fresh

Backend:

bash
cd backend
composer install
php -S 127.0.0.1:8000 -t public

Frontend:

bash
cd frontend
npm install
npm run dev

Set VITE_API_BASE_URL=http://localhost:8000/api/v1 when the frontend runs separately from the backend.

PreviousFAQNextLicensing