This is a multi-tenant, progressive web app (PWA) school management system powered by technologies including the Laravel framework, Bootstrap, jQuery, and the Tenancy package, among others. It is developed for educational institutions such as schools and colleges and is built on Laravel 12.
Run these commands to launch the app locally:
# 1. Clone repository
git clone https://github.com/rayusamBoy/Laravel_tenancy_sms.git
# 2. Navigate into project
cd Laravel_tenancy_sms
# 3. Install PHP dependencies
composer install
# 4. Install JS dependencies
npm install
# 5. Build frontend assets
npm run build
# 6. Prepare database
php artisan key:generate
php artisan storage:link
php artisan migrate --seed --seeder=DatabaseSeederNonTenancy
# 7. Serve locally
php artisan serveFor full setup instructions, see Installation.
Details
- Tenancy capability
- Progressive Web App (PWA) features including Offline access
- Color modes (dark and light)
- Built-in messaging, notifications, and support tickets
- An
IT Guyaccount that can manage nont-tenant operations - Eight (8) types of user accounts
Super admin- Create any user account
- Can delete any record
- Only can access System Settings, Bin and Activity Log
- Manage all notices
- Can perform all
Adminfunction - Only can create & delete message thread
Admin- Create, edit and manage user accounts
- Create, edit and manage Subjects, Exams, Assessments, Books, Pins, Query builder etc.
- Manage payments
- Manage own notices
Teacher- Manage own Class and Section
- Manage Exam records for own Subjects
- Manage timetable if assigned as Class Teacher
- Manage own profile
- Manage own assessments
Student- Manage own profile
- View own subjects and results sheets
- View own assessments sheets
- View library and book status
- View notices and school events in calendar
Parent- Manage own profile
- View, print, download own child's marksheet, assessmentsheet
- View own child's timetable
- View own child's payments
- View notices and school events in calendar
Accountant- Manage payments & fees
- Print Payments receipts
- Manage own profile
- Manage own notices on notice board
Librarian- Manage library books and book requests.
- Manage own profile
Companion- Manage own profile
- View students
- Among others.
Non-tenancy more screenshots.
Tenancy more screenshots.
-
Clone this repository, or you can download the zip folder instead.
git clone https://github.com/rayusamBoy/Laravel_tenancy_sms.git
-
Change to the app installation directory.
cd Laravel_tenancy_sms -
Install the Composer dependencies.
composer install
-
Install then build the Node packages.
npm install
npm run build
-
Create a
.envfile by copying the.env.examplefile.cp .env.example .env
-
Generate the
APP_KEYby running the following command:php artisan key:generate
-
Generate the storage symlink.
php artisan storage:link
-
Set values for specific keys in the
.envfile you created earlier.DB_DATABASE- Database name (make sure you have created one). Default connection:mysql.DB_USERNAME- Database username.DB_PASSWORD- Database password.BROADCAST_CONNECTION- Default:reverb. You can also opt forpusher. Forpusher, make sure to set the appropriate values for any keys that start withPUSHER_, then you will need to activate the credentials in this file.APP_URL- Your full qualified domain with protocolhttps://included. Default:http://localhostVITE_VAPID_KEY- (optional). Firebase Cloud Messaging (FCM) push services access token. To get a key and more check this out.
-
Migrate the database.
php artisan migrate
-
Seed the database.
php artisan db:seed --class=DatabaseSeederNonTenancy
-
(optional). If you have set the optional value for
VITE_VAPID_KEY, you must also configure the Firebase in this file and provide the Firebase service account credentials in this file. The app will work perfectly fine even if you do not set these values. -
(optional). If you have set either or both of the options above, you must rebuild the node packages by running:
npm run build
-
Start the
reverbby running:php artisan reverb:start
Important
Whenever you set or update any value in the .env file for keys that start with VITE_ and/or change the BROADCAST_CONNECTION, you must rebuild the node packages by running:
npm run buildOpen a new terminal, then serve the app and access it via url http://localhost:8000 by running:
php artisan servePlease review the official Laravel deployment guide, and consider searching online for tutorials on deploying a Laravel application tailored to your specific hosting environment.
-
Central app scope
Once you have completed the installation, you can access the central app via the already running URLhttp://localhost:8000using the following credentials.Account Type Username Email Password IT Guy itguyitguy@sms.comitguy
Important
When using a central domain other than localhost (e.g., sms.edu), you must add the domain to the central_domains key in the tenancy configuration file.
'central_domains' => [
'127.0.0.1',
'localhost',
'sms.edu' // Add your central domain here
],-
Tenant app scope
To access the tenant app, you need to create a tenant and tenant domain in the central app. Once that's done, you can use the created domain to access the system with the following credentials.Account Type Username Email Password Super Admin superadminsuperadmin@sms.comsuperadminAdmin adminadmin@sms.comadminTeacher teacherteacher@sms.comteacherCompanion companioncompanion@sms.comcompanionParent parentparent@sms.comparentAccountant accountantaccountant@sms.comaccountantLibrarian librarianlibrarian@sms.comlibrarianStudent studentstudent@sms.comstudent
Note
For more information please refer to this documentation.
Please see contributing for details. Also, show your support by at least becoming one of the stargazers (starring this project) if you find it useful, or if any part of it is helpful.
This project is based on the lav_sms project by 4jean. I would like to express my sincere gratitude to 4jean, to everyone whose code was used, and to all contributors.
The School Management System is open-sourced software licensed under the MIT License.
