Home

Smart School Edit

Simon Mash ERP: Customization & Deployment Guide

Learn how to edit the software yourself, compile changes, and safely update client servers without losing data.

1. The One-Click Installer (XAMPP)

For fresh installations on local Windows servers, you no longer need to type complex commands manually.

⚡ How to use the One-Click Installer
  1. Extract the ERP files into C:\xampp\htdocs\SimonMash_ERP.
  2. Create an empty database in phpMyAdmin and update your .env file credentials.
  3. Inside your ERP folder, find and double-click the file named install.bat.
  4. A terminal will open and automatically install PHP dependencies, run database migrations, install NPM packages, and build the frontend.

Once the script finishes, your ERP is fully installed and ready to use!

2. How to Edit the Code (Using Sublime Text)

Simon Mash ERP uses Vue.js. This means the HTML structure, CSS styling, and Javascript logic are all combined into single files ending in .vue. You can easily make minor edits (like changing font sizes or wording) using Sublime Text.

🔍 Locating and Editing specific text
  1. Open Sublime Text.
  2. Click File > Open Folder... and select your SimonMash_ERP directory.
  3. Press Ctrl + Shift + F to open the "Find in Files" tool at the bottom of the screen.
  4. In the "Find:" box, type the exact text you want to change (e.g., "Welcome to Dashboard").
  5. Click Find. Sublime Text will scan the entire project and show you exactly which .vue file contains that text.
  6. Double-click the search result to open the file. Make your HTML or CSS adjustments, and press Ctrl + S to save.

3. Compiling Your Changes (npm run build)

Because Vue.js code is highly advanced, web browsers cannot read .vue files directly. After you edit and save a file in Sublime Text, you must "build" or compile the code into standard Javascript. This takes the raw code and packages it into the public/build folder.

💻 Step-by-Step Command Prompt Instructions
  1. Click your Windows Start button, type cmd, and press Enter to open the Command Prompt.
  2. Tell the terminal where your files are by typing the following command and pressing Enter:
    cd C:\xampp\htdocs\SimonMash_ERP
  3. Now that you are in the correct folder, trigger the compiler by running:
    npm run build
  4. Wait about 5 to 15 seconds. You will see text scrolling by. When it prints ✓ built in X.XXs, the process is complete!
  5. Refresh your web browser, and you will instantly see the edits you made in Sublime Text.

4. Updating a Client's Server Safely

If you edit this program at your home/office and want to push the changes to a client's computer, you do not need to do a full re-installation, and you will never lose their data.

Why is data safe? All client data (students, fees, attendance) is stored in the MySQL Database, completely separate from the website files.
🚀 The Correct Workflow for Deploying Updates
  1. At your home computer, make your edits in Sublime Text.
  2. Run npm run build at your home computer to compile the changes.
  3. Transfer the specific .vue files you edited to the client's computer (so they have the updated source code).
  4. The Most Crucial Step: Copy your entire public/build folder from your home computer and use it to replace the client's public/build folder.
Because the public/build folder contains the final, compiled code that the browser actually reads, replacing this folder instantly updates the client's software! They don't have to run any commands on their end.

© 2026 Simon Mash ERP Developer Documentation

Post a Comment