Documentation

Installation Guide

Step-by-step instructions for installing SoftCraft applications on Windows, macOS, and Linux. Most users are up and running in under 10 minutes.

Before You Start

License Key

Get it from Dashboard → My Licenses after purchase.

Java 21

Required runtime. Download from adoptium.net/temurin.

4 GB RAM Min

Windows 10+, macOS 12+, or Ubuntu 20.04+

🪟 Windows

1

Download the installer (.zip) from your Dashboard → My Licenses → Download.

2

Extract the zip to a folder (e.g. C:\SoftCraft\SchoolERP).

3

Verify Java is installed: open Command Prompt and run java --version. It should show version 21.

4

Double-click run.bat to launch the application.

5

On first launch, Windows Defender may show a warning. Click "More info" → "Run anyway".

6

The license key dialog appears. Enter your license key from the dashboard.

7

The application initialises with sample data on first run.

If run.bat doesn't work, try: Right-click → "Run as Administrator".

🍎 macOS

1

Download the installer (.zip) from Dashboard → My Licenses → Download.

2

Extract the zip to a location like ~/Applications/SoftCraft.

3

Open Terminal. Navigate to the extracted folder: cd ~/Applications/SoftCraft/SchoolERP

4

Make the run script executable: chmod +x run.sh

5

Run: ./run.sh

6

macOS Gatekeeper may block the app. Go to System Settings → Privacy & Security and click "Open Anyway".

7

Enter your license key when prompted.

For macOS Sonoma and later, you may need to run: xattr -cr . inside the app folder.

🐧 Linux

1

Download and extract the installer zip.

2

Install Java 21: sudo apt update && sudo apt install openjdk-21-jdk

3

Install Maven: sudo apt install maven

4

Navigate to the app folder in terminal.

5

chmod +x run.sh && ./run.sh

6

Enter your license key when prompted.

On Ubuntu, you may need to install JavaFX separately: sudo apt install openjfx

Troubleshooting

"Java not found" or "JAVA_HOME not set"

Install Java 21 from adoptium.net and restart your computer. Then try again.

Application launches but shows blank screen

This is usually a JavaFX rendering issue. Update your graphics drivers. On Windows, try running with: java -Dprism.forceGPU=false -jar app.jar

"License key invalid" even with correct key

Copy the key directly from your dashboard (click the copy icon). Ensure there are no leading/trailing spaces. Keys are case-sensitive and in the format XXXXX-XXXXX-XXXXX-XXXXX-XXXXX.

"Maximum activations reached"

Your license allows limited device activations. Deactivate an old device from Dashboard → My Licenses, or upgrade to a plan with more activations.

Database error on startup

Delete the database file (schoolerp-data.mv.db or similar) in the app folder and restart. Note: this clears all data.

Port already in use error

The app uses an embedded server on port 8099. Kill any process on that port or change it in application.properties.

Still having trouble?

Our support team responds within 4 hours on business days.