We like to challenge the quality of what we build to make it better. To do so, we try to make the product intuitive, beautiful, and user friendly. Innovation and hard work help to fulfill these requirements. I believe in order to innovate we need to think differently. A few months ago I discovered there was no open source free school management software that met my quality standards. I happen to know a bit of programming so I decided to make one. I also believe that working with more people can push the standard higher than working alone. So I decided to make it open source and free.
Community contribution can make this product better!! See Contribution guideline before making any Pull request
- We want testable softwares. So test cases are being written for this app too. You also can contribute by writing test case!
- To run Feature and Unit Tests use
./vendor/bin/phpunit
and to run Browser Tests setAPP_URL
environment variable in your.env
file. This value should match the URL you use to access your application in a browser. Then runphp artisan dusk
.
GNU General Public License v3.0
This software has following features:
- Roles: Master, Admin, Teacher, Student, Librarian, Accountant
- Attendance
- Mark
- Registration
- Notice, Syllabus
- Library
- Exam
- Grade
- Accounts
- Messaging
- Laravel 5.5
- Bootstrap 3.3.7
Here are some basic steps to start using this application
Note: Instruction on cached data for Dashboard is given in Good to know segment below.
-
Run
php composer.phar install
for developer environment and runphp composer.phar install --no-dev
for production environment to install Laravel packages -
Create
.env
file from.env.example
and generateAPP_KEY
usingphp artisan key:generate
-
Set the database connection configuration and APP_ENV according to your application environment (e.g. local, production) in
.env
file -
To create a
Master
, go to thedatabase\seeds\UsersTableSeeder.php
and change thename
, theemail
and thepassword
settings to your likings. Leave the other settings (role, active, verified) unchanged! -
Laravel Passport package is included to support API. Key for Passport should be automatically generated by
php artisan passport:keys
frompost-install-cmd
script incomposer.json
or you have to run this manually and to remove this package just follow these steps- Remove it from
composer.json
require dependencies and remove command@php artisan passport:keys
frompost-install-cmd
script - Run
composer update
andcomposer dump-autoload
. - And all classes that relies on passport must be edited as well. The most common classes are:
app\User.php
model, remove theHasApiToken
trait.app\Proiders\AuthServiceProvider
, removePassport::routes();
in your boot method.- In
config/auth.php
, change your driver option forapi
frompassport
toapi
authentication
- Remove it from
-
To create the tables, run
php artisan migrate
.- If you don't want to use Passport package then remove the Passport Migrations in database
migrations
table and run commandartisan migrate:refresh
- If you don't want to use Passport package then remove the Passport Migrations in database
-
To seed the tables with fake data, use
php artisan db:seed
. -
If you want to run the migration and the seeding together, use
php artisan migrate:refresh --seed
-
You must seed
database\seeds\UsersTableSeeder.php
at least once in order to create the Master account. To do so, follow these steps:- comment all the seeders except
$this->call(UsersTableSeeder::class);
indatabase\seeds\DatabaseSeeder.php
; - then comment
factory(App\User::class, 200)->create();
inUsersTableSeeder.php
.
So your files will look something like this:
In
database\seeds\DatabaseSeeder.php
:... //$this->call(SectionsTableSeeder::class); $this->call(UsersTableSeeder::class); //$this->call(AttendancesTableSeeder::class); ...
In
database\seeds\UsersTableSeeder.php
:... //factory(App\User::class, 200)->create();
- comment all the seeders except
- Important: only a
master
can create a new school and its admins! - Login at
example.com\login
using yourMaster
account credentials - Create a new
school
- Create a new
admin
for the newly created school
- Important: A
master
CANNOT manage a school's data! - Login as
admin
atexample.com\login
- Now add data to the school as required.
- In
.env
, turnAPP_DEBUG
tofalse
for production environment. - You can switch to and from maintenance mode by running
php artisan up
andphp artisan down
. - Dashboard page contents(e.g. Student count, Teacher count, Notice, etc.) are cached because these are not frequently changed. If you don't want these to be cached, just remove the cache lines in
index
method inapp\Http\Controller\HomeController.php
like the following example. So your edit would be something like this:
From:
...
$classes = \Cache::remember('classes', $minutes, function () {
return \App\Myclass::where('school_id', \Auth::user()->school->id)
->pluck('id')
->toArray();
});
...
To:
...
$classes = \App\Myclass::where('school_id', \Auth::user()->school->id)
->pluck('id')
->toArray();
...
You can do similar for other cache lines.
Auto generated fake data were used.