changeweb/unifiedtransform

A school management Software

Version 2.X is here!!

For Version 1.X, view releases. Continuation of Version 1.X support in v1-x-branch branch.

School Management and Accounting Software

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.

Featured on Laravel News !!

See the news here

Framework used

• Laravel 8.X
• Bootstrap 5.X

Server Requirements

• PHP >= 7.4
• OpenSSL PHP Extension
• PDO PHP Extension
• Mbstring PHP Extension
• Tokenizer PHP Extension
• XML PHP Extension

Testing

• We want testable softwares. Most parts of the software in the previous version 1.x were covered by tests. Lets cover version 2.x as well. You also can contribute by writing test case!

• To run Feature and Unit Tests run following commands:

  $ docker exec -it app sh
  // Inside container shell
  :/# php artisan test

License

GNU General Public License v3.0

Contribute

Unifiedtransform is 100% open source and free forever!!

Community contribution can make this product better!!

When you contribute to a Github project you agree with this terms of Github Terms of Service(Contributions Under Repository License).

Since this project is under GNU General Public License v3.0, according to Github's Terms of Service all your contributions are also under the same license terms. Thus you permit the user of this software to use your contribution under the terms of GNU General Public License v3.0.

Whats New

v2.X is built from scratch. Both UI and internal workflow of the application are changed to a better design.

Features yet to be migrated from v1.X to v2.X

Following features that exist in v1.X will be added in v2.X as well in future.

• Stripe payment
• Messaging
• Managing library
• Managing Income and Expenses
• Mass student and teachers export and import.
• Printing reports
• Managing certificates.
• Supported other languages (Spanish, ...).

How to Start

Using Docker Container:

Video instruction

ut-installation-2023-04-11_22.23.11.mp4

Document instruction

Docker is now supported and improved.

How To Set Up Laravel, Nginx, and MySQL With Docker Compose on Ubuntu 20.04

With the improved Docker setup, you will get:

• Nginx
• PHP 7.4
• MySQL 5.7

Steps to install:

1. Clone or donwload the repository.

2. Create purify folder in storage/app/ directory.

3. Run cp .env.example .env.

4. Run docker-compose up -d.

5. Run docker exec -it db sh. Inside the shell, run:

   :/# mysql -u root -p

   Mysql Root password: your_mysql_root_password in the docker-compose.yml file. Then run following commands:

   mysql> SHOW DATABASES;
   mysql> GRANT ALL ON unifiedtransform.* TO 'unifiedtransform'@'%' IDENTIFIED BY 'secret';
   mysql> FLUSH PRIVILEGES;
   mysql> EXIT;

6. Finally, exit the container by running exit in the container shell.

7. Run docker exec -it app sh. Inside the shell, run following commands:

   :/# composer install
   :/# php artisan key:generate
   :/# php artisan config:cache
   :/# php artisan migrate:fresh --seed

   Then exit from the container.

8. Visit http://localhost:8080. Admin login credentials:

   • Email: [email protected]
   • Password: password

Steps to follow:

Please carefully follow the steps to setup the school.

Role: Admin

School Dashboard

1. Create a School Session:

After logging in for the first time, you will see following message at the top nav bar.

To create a new session, go to Academic Settings page.

Academic Settings page:

Successful creation of session using following form will display success message:

2. Create a Semester

Now create a semester. A semester duration usually is 3 - 6 months.

3. Create classes

Now create classes. Give common names such as: Class 1 or Class 11 (Science).

4. Create sections

Now create sections for each classes. Give section's name (e.g.: Section A, Section B), room number and assign them to respective class.

5. Create Courses

Now create courses and assign them to respective semester and class.

6. Set attendance type

Attendance can be maintained in two ways: 1. By section, 2. By course. Stick to one type for a semester. Default: By section.

7. Add teachers

Now add teachers.

8. Assign teacher

Now assign teachers to semester, class, section, and course.

9. Add students

Now add students and assign them to class, and section.

10. View added teachers and students

Now browse to View Teachers and View Students pages.

11. View student and teacher profile

Now browse to Profile from student and teacher list.

12. View and Edit Classes and Sections

Now go to Classes. Here you can view all classes and their respective sections, syllabi, and courses. Classes, sections, and courses can be edited from here.

13. Create Grading Systems

Now create grading system for each class and a semester.

14. View Grading Systems

Now browse to created Grading Systems.

15. Add and view Grading System Rules

Now add rules to the grading system and browse them.

16. Add Notices

Admin can add notice. Right now, notices can be written using a rich text editor.

17. Create Events

Events can be created inside a calendar. Click and drag on a date or time period to prompt the input box. An already created event can be deleted by clicking on the event.

18. Create and view Routines

Routines can be created for each class and section.

19. Add Syllabi

Syllabus for each class and course can be added. Admin can view them from Classes page. Syllabus can be downloaded.

20. Browse by Sessions

You can browse previous sessions like a snapshot. This mode is Read only. Nobody should be able to change the previous sessions' data.

21. Allow Teachers to submit Final Marks

Submitting final marks of a semester should be controlled. By enabling this feature, it is possible to open a Mark Submission Window for a short time period. Default: Disallowed.

22. Promote students

Students can only be promoted to a new class and section when a new Session along with its classes and sections are created.

Role: Teacher

Teacher's dashboard

1. View assigned courses

Teachers can manage their assigned courses from this page. From this page, teacher can do following:

• Take and view attendance
• View Syllabus
• Create and view Assignment
• Give Marks
• Message Students (Available in v1.X. Will be added in v2.X as well).

2. Take attendance

Teacher can take attendance for a section or a course (attendance type set by Admin).

3. View attendance

Teacher can view attendance.

4. View syllabus

Teacher can view and download syllabus.

5. Create assignment

Teacher can create assignment for an assigned course by uploading files.

6. View assignments

Teacher can view and download created assignments.

7. Create Exams

Before giving marks, teacher needs to create exams and set their rules. Don't have to create all the exams at a time. (Admin can also create exams on behalf of teachers).

8. View created exams

Teacher can view their created exams.

9. Add, edit and view exam rules

Teacher can add, edit, and view exam rules.

10. Give marks

Teacher can give marks after creating exams. Clicking on the exam names will lead to associated exam rules.

11. Submit Final Marks

When the Grade submission window is open, teacher can submit final marks. Calculated marks will be generated based on all exams' marks. Final marks should be in between the marks set in the grade rules.

If final marks is submitted, a message will be shown in place of submit button in Give Marks page.

12. View Final Results

Teachers can view final results and calculated grades for a semester, class, section, and course based on their created grade rules.

Role: Student

Student dashboard

1. View attendance

A student can view his/her attendance.

2. View courses

A student can view his/her courses that are assigned in his/her class. From here, a student can do following:

• View Marks
• View Syllabus
• View Assignments

3. View Marks

A student can view marks, final results and grade for a course.

4. View and download Syllabus

Students can view and download syllabi of their courses just like their teachers.

5. View and download assignments

Students can view and download assignments of their courses just like their teachers.

6. View routine

Students can view their class and section routine just like their admin/teachers.

unifiedtransform's Issues

Moving Request validation to FormRequse

A way to view newly created School Admin

Is your feature request related to a problem? Please describe.
When I create a school's admin, I get a notification saying the admin has been saved, but I don't see my newly created admin.

Describe the solution you'd like
Perhaps, include a link to open the newly created school admin in a new tab in the "Saved" notification.

Describe alternatives you've considered
I've considered redirecting the user to the "View Admins" school/admin-list/2 page, but a user might be interested in entering multiple admins one after the other.

Also, this is really amazing work you're doing!

Expose a Design Document

I'd like to contribute when I can, but it's hard knowing your intentions for parts of the application that haven't been completed yet.

Could you provide a document that gives the design of the application? A good and simple format to begin with is:

Class

This is a description of a school's class. It does this and that ... Its properties are:

• Property 1
• Property 2

Section

A class can have multiple sections. It represents the divisions within a single class ... It's properties are:

• Property 1
• Property 2

Blood Group?

I would like to know, if there is any use case in any school in the world, that requires a pupil or teacher or parent to give in their blood type? I am from Austria, and I never heard of such a thing.

(I know that other school systems like eduella do have a similar field...)

Docker compose fails

Describe the bug
The docker-compose up -d fails. Tried running non-daemon and fails in same place

To Reproduce
Steps to reproduce the behavior:

1. Run docker-compose up -d
   Here is the output after starting with the build container:
   Build complete.
   Don't forget to run 'make test'.

Installing shared extensions: /usr/local/lib/php/extensions/no-debug-non-zts-20170718/
Installing header files: /usr/local/include/php/
find . -name *.gcno -o -name *.gcda | xargs rm -f
find . -name *.lo -o -name *.o | xargs rm -f
find . -name *.la -o -name *.a | xargs rm -f
find . -name *.so | xargs rm -f
find . -name .libs -a -type d|xargs rm -rf
rm -f libphp.la modules/* libs/*
Removing intermediate container e70af477d41e
---> ddbb834e889d
Step 9/22 : RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
---> Running in c55c8e4d76c9
All settings correct for using Composer
Downloading...

Composer (version 1.8.5) successfully installed to: /usr/local/bin/composer
Use it: php /usr/local/bin/composer

Removing intermediate container c55c8e4d76c9
---> a2ee463e778f
Step 10/22 : RUN groupadd -g 1000 www
---> Running in 2e028056fedf
Removing intermediate container 2e028056fedf
---> cc5484e6d6f1
Step 11/22 : RUN useradd -u 1000 -ms /bin/bash -g www www
---> Running in 4e5c4947c083
Removing intermediate container 4e5c4947c083
---> 8dde88ad551c
Step 12/22 : COPY . /var/www
---> f7eb563798e1
Step 13/22 : COPY --chown=www:www . /var/www
---> 3423b85ae89c
Step 14/22 : USER www
---> Running in a26307cda5cf
Removing intermediate container a26307cda5cf
---> b132261fac73
Step 15/22 : RUN composer install
---> Running in c59b9fe4b987
Loading composer repositories with package information
Installing dependencies (including require-dev) from lock file
Warning: The lock file is not up to date with the latest changes in composer.json. You may be getting outdated dependencies. Run update to update them.
Package operations: 104 installs, 0 updates, 0 removals

[RuntimeException]
/var/www/vendor does not exist and could not be created.

install [--prefer-source] [--prefer-dist] [--dry-run] [--dev] [--no-dev] [--no-custom-installers] [--no-autoloader] [--no-scripts] [--no-progress] [--no-suggest] [-v|vv|vvv|--verbose] [-o|--optimize-autoloader] [-a|--classmap-authoritative] [--apcu-autoloader] [--ignore-platform-reqs] [--] []...

ERROR: Service 'app' failed to build: The command '/bin/sh -c composer install' returned a non-zero code: 1

A clear and concise description of what you expected to happen.
I expected the containers to start

Desktop (please complete the following information):

• OS: Ubuntu 18.04 64bit

I was just trying to get the containers to complete so I could look at the tool

How to start with the app?

I created a user with name, email and password using artisan tinker. Then, after login, I get this error: "Trying to get property of non-object". It seems the systems wants to know, which school the user belongs to. But since there is no data, nothing can be found.

How can I initialize the system correctly?

Feedback feature?

Hie, as scool project your misisng put a most important feature feedback from the students about the school environment and quality of education. Let me know, if you require any help. Thanks

Add Impersonation

Is your feature request related to a problem? Please describe.
When testing, I have to logout and login as the user I need to use.

Describe the solution you'd like
With Laravel Impersonate, I can pick a user I'd like to impersonate and see the application through that user's eyes. This is really helpful when testing.

We can have an "Impersonate" link/button on the user profile dropdown at the top-right of the screen, allowing the user to select a user besides themselves to impersonate.

Additional context
This feature can be made only accessible in dev/staging environment, for security reasons.

A more advanced approach will be allowing users in a higher role/state-hierarchy to impersonate users under them. E.g. A master should be able to impersonate any of

• admin
• accountant
• librarian
• teacher
• student

An admin can only impersonate

• accountant
• librarian
• teacher
• student

How to upload/define Syllabus. what is syllabus format?

Hi,
Please share the syllabus copy.

Add Manual Bank Transfer Payment

Is your feature request related to a problem? Please describe.
No,

Describe the solution you'd like
I want a feature that can add payment section for manual payment for registration, etc,
student candidate open a register to our school,
apply for registration,
The Fee is transfer manually using direct bank transfer to our bank account...
student candidate upload a proof of succesful payment...
accounting staff or admin can update the status after checking the succesful bank transfer,
student candidate process further...

Invite mail to newly added user

Is your feature request related to a problem? Please describe.
I added a school admin, and expected the admin to get an email.

Describe the solution you'd like
Send a mail, inviting the user to the system.

I want to use it as a community management software.

I want to use it to do a school community management software.Building a page with vuejs, I don't know where to start

Mobile application

can we have mobile version of this application. It will be useful for Teachers and parents to make use of features like Attendance, Homework, Marks, Events etc.

Cache Path

create these folders under storage/framework:

1. sessions
2. Views
3. Cache

How to create initial user?

It would be great, if the docu could say, how to create an initial user. (Not everybody is Laravel or artisan tinker pro...)

There are no buttons for creating users

I'm trying to add new students, but there are no button for this in Manage Schools section.

Cannot issue book to student from librarian account

Describe the bug
when i try to issue a book to student from librarian's account it gives error.
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to 'http://127.0.0.1:8000/library/issue-books' and add information
2. Click on 'Save'
3. Scroll down to 'errors'
4. See error

Expected behavior
the book should be issued by the librarian

Screenshots

Desktop (please complete the following information):

• OS: Win 7
• Browser:chrome 73.0.3683.86
• Version [e.g. 22]

Smartphone (please complete the following information):
NA

Additional context
steps i performed after cloning

1. create env file
2. migrate and seed

install fails

What shall I do?
Generating optimized autoload files

Illuminate\Foundation\ComposerScripts::postAutoloadDump
@php artisan package:discover

In ProviderRepository.php line 208:

Class 'Barryvdh\Debugbar\ServiceProvider' not found

Script @php artisan package:discover handling the post-autoload-dump event returned with error code 1

New Table column added

A new column active is added in exam_for_class table in a new migration file.

Update your repository with latest master branch and just run php artisan migrate to update your database table.

Unexpected exception while grade saving

I tried to save a grade and received this exception

Docker Compose

It will be much easier if you can dockerize and make it seamless

/login is Loading some loaders

http://127.0.0.1:8000/login as am hitting this url its loading some loaders, no page is getting load any issues??

Database seeder throws error

If I activate all seeds in dataabase/seeds/DatabaseSeeder using php artisan migrate:refresh --seed on an empty DB table, the following errors are thrown:

In Connection.php line 664:
                                                                                                                         
  SQLSTATE[23000]: Integrity constraint violation: 1048 Column 'student_id' cannot be null (SQL: insert into `attendanc  
  es` (`present`, `student_id`, `section_id`, `updated_at`, `created_at`) values (2, , 19, 2019-03-19 13:42:18, 2019-03  
  -19 13:42:18))                                                                                                         
                                                                                                                         

In Connection.php line 458:
                                                                                            
  SQLSTATE[23000]: Integrity constraint violation: 1048 Column 'student_id' cannot be null

If I run the same command on the same DB table again (meaning the DB has all the tables now), this errors are thrown:

In Connection.php line 664:
                                                                                                                         
  SQLSTATE[42000]: Syntax error or access violation: 1091 Can't DROP 'department'; check that column/key exists (SQL: alter table `users` drop `department`)                                                                                  
                                                                                                                         

In Connection.php line 458:
                                                                                                                 
  SQLSTATE[42000]: Syntax error or access violation: 1091 Can't DROP 'department'; check that column/key exists

There was a departments (plural!) table. It gets remove somewhere at the beginning, when the artisan script starts. I guess that at the time, when the users table is called, the departments table does simply not exist anymore...

Admin cannot add users like students,teachers etc cannot upload events as well

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.

please support sqlite database

Is your feature request related to a problem? Please describe.
the php artisan db:seed installation step fails with the following error when using a sqlite database:

Seeding: SchoolsTableSeeder
Seeding: DepartmentTableSeeder
Seeding: ClassesTableSeeder
Seeding: SectionsTableSeeder
Seeding: UsersTableSeeder

In Connection.php line 664:
                                                                               
  SQLSTATE[23000]: Integrity constraint violation: 19 NOT NULL constraint fai  
  led: users.school_id (SQL: insert into "users" ("name", "email", "password"  
  , "role", "active", "verified") values (hasib, [email protected],   
  $2y$10$FK.RtT1g1yJeadgZOOuRReJOcQeCpZK3dhJ8Zjy7XEysIP2K0FYfu, master, 1, 1)  
  )                                                                            
                                                                               

In PDOStatement.php line 119:
                                                                               
  SQLSTATE[23000]: Integrity constraint violation: 19 NOT NULL constraint fai  
  led: users.school_id                                                         
                                                                               

In PDOStatement.php line 117:
                                                                               
  SQLSTATE[23000]: Integrity constraint violation: 19 NOT NULL constraint fai  
  led: users.school_id                                                         
                                                            

Describe the solution you'd like
The ability to use sqlite instead of mysql

Additional context
here's a shell script to reproduce (on debian9)

cd /var/www/html \
&& shopt -s dotglob \
&& rm -rf * \
&& ssh-keyscan -t rsa github.com >> /etc/ssh/ssh_known_hosts \
&& git clone https://github.com/changeweb/Unifiedtransform.git . \
&& cp .env.example .env \
&& sed -i '/^DB_/d' .env \
&& echo >> .env \
&& echo 'DB_CONNECTION=sqlite' >> .env \
&& echo 'DB_DATABASE=/var/www/storage/database.sqlite' >> .env \
&& touch storage/database.sqlite \
&& chown -R www-data:www-data storage \
&& chown -R www-data:www-data bootstrap/cache \
&& curl -so /tmp/composer.phar https://getcomposer.org/composer.phar \
&& php /tmp/composer.phar require doctrine/dbal \
&& php /tmp/composer.phar install \
&& php artisan key:generate \
&& php artisan migrate --database=sqlite \
&& php artisan db:seed 

everything works up to the very last command, which returns the error above

Moving Request validation to FormRequest

Currently Controllers are very large and doing lot stuff which shouldn't be there. I would like to move request validation from Controllers to FormRequest. I will first do it on the UserController as an example.

This way Controller will do what its suppose to be doing with the data and let the FormRequest validate those data.

Please provide install instructions for dumb

Thank you so much for your work!
I would like use this application, but I ca not not start in locally in docker

Could you please provide detailed step by step guide?

Thanks in advance,
Andrii

Issues found in Xampp

Describe the bug
1.Not able to create fee structure for class not not able to see fees for students
2. Not able to print student info/fee > export will be a great option
3. If syllabus can visible to students it will be great help , we can keep links to our LMS
4. Any documentation to host via Cpanel ?

count(): Parameter must be an array or an object that implements Countable

When i login using teach account and goto Studens->View Attendance.
in AttendanceController.php on line# 60

Some bug reporting

Admin -> Profile>
"count(): Parameter must be an array or an object that implements Countable (View: D:\xampp\htdocs\school\resources\views\profile\user.blade.php)"

you can change:

count($user) > 0

to:

$user

in two if statement and that would work.

---

Also, teacher can't be made. Error:

"count(): Parameter must be an array or an object that implements Countable"

---

Then, when I made admin for school, register button is useless since I just click on upload pic and admin is made. Without pic upload I can't made admin which is lame.

---

I have more, but this is enough for now...

Registering a new admin for a new school is not possible

After filling out the info and hitting the save "Register" button, the site reloads the register site, but without saving the data to the DB (looking into the DB, no new user was added).

As a side note: IMO, the registration site should have a button that leads back to the "Manage school" site. Otherwise, you are stuck on the registration site forever...

Can't run artisan

Cannot generate app key with artisan. Directory ./vendor/ is missing

Teachers and Staffs Attendance not linked?

Hi there,

I am having an issue with Teachers and Staffs Attendance which is not linked on the sidebar.

Is that feature implemented?

Best regards
Mo

Parents Module.

I think it would be important if the has would have a parents module where they can login and perform some activities.
For example.
Make fees payments,etc.

Add translation support

Is your feature request related to a problem? Please describe.
I think if there is translation support will be great, our school society not all good in english

Describe the solution you'd like
I hope if there is a translation feature, in-system either in-database multi language content support

Describe alternatives you've considered
Or, give config to load in-system translation on installation step and leave the in-database language single language.

Additional context
Here multi languages database design proposal, using the third approach :
Multi language database design
And for the in-system localization just follow the Laravel way
Laravel Localization

I am ready for contributing on translation to Indonesia (ISO code: ID) and code or design pattern, but i am still learning laravel, however a great Open Source Application 👋

Add demo site

It will be very useful to add demo website

Important Notice: issue_books column changed

For better handling and future improvement, in 'issue_books' table a column has been changed.

book_code changed to book_id as a Foreign key.

For people who don't have latest changes:

To update your repository's database with this change run php artisan migrate:refresh --seed

env file

where is the .env file?

dashboard issue

dashboard for one school remain cached for other school

Undefined variable: school_id

When I login As a School Admin I got this error

Ed-Fi Alliance

My job is in the education software realm and I thought I would share a bit of helpful information with you. There is an up and coming solution to sharing SIS data between platforms, vendors, and the likes. I would recommend you taking a look to see if this is something you might want to move the product towards supporting: https://www.ed-fi.org/

Thank you for working on bringing open source educational software forward!

Route list error and solution

php artisan route:list is not working. Error:
Key path "file://C:\xampp\htdocs\musicSchoolDB\storage\oauth-private.key" does not exist or is not readable

You must enter command php artisan passport:keys to be able to use route list.

---

@changeweb

Why master can't edit admins? Admin can't edit it's own profile either.

And, do you plane to add translate to other languages?

This is excellent software but I think it need a lot of work. I would love to help.

Bulk Importer

Is your feature request related to a problem? Please describe.
Most of the schools already have existing students,teachers,etc. In addition to the add student/add teacher etc options they should get an option to register/add/import thier exisiting students/teachers. I think I don't have to describe the problem in detail as You might know how much important it is :)

Describe the solution you'd like
Let's have an option to upload excell or csv file to register/import the students,teachers etc.

Describe alternatives you've considered
Or admin can register student with minimum options like name/class/section/mail & password then students can fill up other (non-required) information on thier own.

Additional context
But either of the solution bulk uploader is a really necessary feature I believe.

Assignment features?

Is there any feature around:

• home work assignments (teachers giving the assignments consulted by students)
• Students <-> Teachers Messaging

Thank you for your good work!

Class 'Barryvdh\Debugbar\ServiceProvider' not found

During composer Install I'm getting this error in dev mode:

In ProviderRepository.php line 208:
Class 'Barryvdh\Debugbar\ServiceProvider' not found

Tried to deploy on heroku as well but didn't worked.

Can windows run this project?

window10+wamp64;
when run artisan, show:
In ProviderRepository.php line 208:

Class 'Rap2hpoutre\LaravelLogViewer\LaravelLogViewerServiceProvider' not found

Migrate to Bootstrap 4 (plan for v5)

Its based on Bootstrap 3, which is quite old now. You should consider moving to bootstrap 4, and plan for Bootstrap 5 as 2019 is the planned year for its release.

Interface looks totally different

When starting the app, I get a totally different, very rudimentary view of the backend. It seems it is only the route view without any layout. Are there any additional steps to get the backend dashboard running? Some gulp or webpack probably?

Explain the use of all features in video or article.

It will really help a lot if someone can explain all the features and user instructions in a video or an article for ease.

Father and mother mixed up in screenshots

Not sure if its just bad data but the mother and father fields seem to be swapped in the screenshots