## CloudSchool

[![Codeship Status for hrshadhin/school-management-system](https://app.codeship.com/projects/09010350-b97f-0136-1477-5a7589b245e6/status?branch=master)](https://app.codeship.com/projects/312233)
[![license](https://img.shields.io/badge/license-AGPL-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
[![php](https://img.shields.io/badge/php-7.2-brightgreen.svg?logo=php)](https://www.php.net)
[![laravel](https://img.shields.io/badge/laravel-6.x-orange.svg?logo=laravel)](https://laravel.com)

```
                       _____  _                    _   _____        _                    _ 
                      / ____|| |                  | | / ____|      | |                  | |
                     | |     | |  ___   _   _   __| || (___    ___ | |__    ___    ___  | |
                     | |     | | / _ \ | | | | / _` | \___ \  / __|| '_ \  / _ \  / _ \ | |
                     | |____ | || (_) || |_| || (_| | ____) || (__ | | | || (_) || (_) || |
                      \_____||_| \___/  \__,_| \__,_||_____/  \___||_| |_| \___/  \___/ |_|       
```                                                                                                                               

Another School Management System build with Laravel and PHP 7

## :loudspeaker: **For Enterprise Edition(EE) checkout [here](https://github.com/hrshadhin/school-management-system/tree/empty)**

## Index

- [Have a Query?](#have-a-query)
- [Demo](#demo)
  - [Enterprise Edition (EE)](#enterprise-edition)
- [Features](#features)
- [Installation](#installation)
  - [Installing dependencies](#installing-dependencies)
  - [Download and setup](#download-and-setup)
  - [Use the app](#use-the-app)
- [Documentation](#documentation)
- [Changelog/Timeline](#timeline)
- [Screenshot](#screenshot)
- [Contributing](#contributing)
  - [To-do](#to-do)
  - [Contributers](#contributers)
- [Issues](#issues)
- [License](#license)

## Have a query

[:arrow_up: Back to top](#index)

:mega: Join our discord channel: [CloudSchool](https://discord.gg/7rXyuu8):mega:

:mega: Send us an email: [info@cloudschoolbd.com](mailto:info@cloudschoolbd.com):mega:

## Demo

[:arrow_up: Back to top](#index)

#### Enterprise Edition

- Website: [http://demo.cloudschoolbd.com](http://demo.cloudschoolbd.com)
- App login: [http://demo.cloudschoolbd.com/login](http://demo.cloudschoolbd.com/login)

  | Username   | Password |
  | ---------- | :------- |
  | superadmin | super99  |
  | admin      | demo123  |

## Features

[:arrow_up: Back to top](#index)

| Community Edition                            |              Enterprise Edition              |
| -------------------------------------------- | :------------------------------------------: |
| Academic Year manage                         |             Academic Year manage             |
| Academic Calendar Setup                      |           Academic Calendar Setup            |
| Institute Setup                              |               Institute Setup                |
| Class & Section Manage                       |            Class & Section Manage            |
| Subject & Teacher Manage                     |           Subject & Teacher Manage           |
| Student Admission                            |              Student Admission               |
| Student Attendance                           |              Student Attendance              |
| Exam & Grading Rules                         |             Exam & Grading Rules             |
| Marks & Result                               |       Easy Marks Entry & Result Manage       |
| Student Promotion                            |  Dynamic and more advance Student Promotion  |
| Employees Manage                             |               Employees Manage               |
| Employees Attendance                         |             Employees Attendance             |
| Employees Leave                              |               Employees Leave                |
|                                              |            Employees Work Outside            |
|                                              |              SMS Gateway Setup               |
|                                              |            Email & SMS Templating            |
|                                              |      Attendance notification email/sms       |
|                                              |           Id Card templates Manage           |
|                                              |       Employee & Student id card print       |
| User & Role manage with permission grid(ACL) | User & Role manage with permission grid(ACL) |
| User wise Dashboard                          |             User wise Dashboard              |
| Report Settings                              |               Report Settings                |
| Only 5 Reports                               |               **40+** Reports                |
| Dynamic Front Website                        |            Dynamic Front Website             |
| Website Management Panel                     |           Website Management Panel           |
| Photo Gallery                                |                Photo Gallery                 |
| Event Manage                                 |                 Event Manage                 |
| Google Analytics                             |               Google Analytics               |
| User Notification                            |              User Notification               |
|                                              |               Online Admission               |
|                                              |         Online Admit Card & Payslip          |
|                                              |                 Notice Board                 |
|                                              |  Student & Employee Id card bulk/mass print  |
|                                              |                Account Manage                |
|                                              |                Budget Manage                 |
|                                              |                Account Heads                 |
|                                              |               Student Invoice                |
|                                              |           Income / Expense Manage            |
|                                              |                   Payroll                    |
|                                              |               Salary Template                |
|                                              |           Employee Salary Payment            |
|                                              |          Hostel & Collection Manage          |
|                                              |                Library Manage                |
|                                              |        Issue book and fine collection        |
|                                              |           Academic Calendar Print            |
|                                              |          Bulk SMS and Email Sending          |
|                                              |               **40+** Reports                |

## Installation

[:arrow_up: Back to top](#index)

#### Installing dependencies

- PHP >= 7.2
- OpenSSL PHP Extension
- PDO PHP Extension
- Mbstring PHP Extension
- Tokenizer PHP Extension
- XML PHP Extension
- Ctype PHP Extension
- JSON PHP Extension
- MySQL >= 5.6 `OR` MariaDB >= 10.1
- [hrshadhin/laravel-userstamps](https://github.com/hrshadhin/laravel-userstamps.git) [**Already Installed**]
- NodeJS, npm, webpack

#### Download and setup

- Clone the repo

  **For Windows run below commands before cloning the Repo.**

  ```
  git config --global core.eol lf
  git config --global core.autocrlf false
  ```

  ```
  $ git clone https://github.com/hrshadhin/school-management-system.git cloudschool
  ```

- change directory
  ```
  $ cd cloudschool
  ```
- Copy sample `env` file and change configuration according to your need in ".env" file and create Database
  ```
  $ cp .env.example .env
  ```
- Install php libraries
  ```
  $ composer install
  ```
- Setup application
 - Setup application 
- Setup application
 - Setup application 
- Setup application

  - Method 1: By one command

    ```
    # setup cloudschool with out demo data
    $ php artisan fresh-install

    # setup cloudschool with demo data
    $ php artisan fresh-install --with-data
     # OR
    $ php artisan fresh-install -d
    ```

  - Method 2: Step by step

    ```
    $ php artisan storage:link
    $ php artisan key:generate --ansi

    # Create database tables and load essential data
    $ php artisan migrate
    $ php artisan db:seed

    # Load demo data
    $ php artisan db:seed --class DemoSiteDataSeeder
    $ php artisan db:seed --class DemoAppDataSeeder

    # Clear all caches
    $ php artisan view:clear
    $ php artisan route:clear
    $ php artisan config:clear
    $ php artisan cache:clear
    ```

- Install frontend(css,js) dependency libraries and bundle them
  ```
  $ npm install
  $ npm run backend-prod
  $ npm run frontend-prod
  ```
- Start development server
  ```
  $ php artisan serve
  ```

#### Use the app

[:arrow_up: Back to top](#index)

- Website: [http://localhost:8000](http://localhost:8000)
- App login: [http://localhost:8000/login](http://localhost:8000/login)

  | Username   | Password |
  | ---------- | :------- |
  | superadmin | super99  |
  | admin      | demo123  |

## Documentation

[:arrow_up: Back to top](#index)

- [http://ug.cloudschoolbd.com](http://ug.cloudschoolbd.com)

## Timeline

- [Check Here](CHANGELOG.md)

## Screenshot

[:arrow_up: Back to top](#index)

- ![Dashboard](../assets/screenshots/ce/dashboard.png?raw=true)
- **[More...](../assets/screenshots/ce/showme.md)**

## Contributing

[:arrow_up: Back to top](#index)

Don't be shy to make some PR's here :smile:

#### To-do

- [ ] Add **unit & integration**. Like real quick!
- [ ] Add shortcut link for create things. i.e: `student`, `attendance`, `marks` etc
- [ ] Add new UI theme version **AdminLTE**
- [ ] Update Jquery with datetime picker library

#### Contributers

A big shout out to all the contributers, more specifically to these guys

- [H.R. Shadhin](https://github.com/hrshadhin)
- [Ashutosh Das](https://github.com/pyprism)
- [order4adwriter](https://github.com/order4adwriter)
- [Zahid Irfan](https://github.com/zahidirfan)
- [Oshane Bailey](https://github.com/b4oshany)

## Issues

[:arrow_up: Back to top](#index)

- If you faced any problems, first check previous issue list. If doesn't exists then create a new one.
- You can report the bugs at the [issue tracker](https://github.com/hrshadhin/school-management-system/issues)
- If you discover a security vulnerability within CloudSchool app, please send an e-mail to [sos@cloudschoolbd.com](mailto:sos@cloudschoolbd.com). All security vulnerabilities will be promptly addressed.

## License

[:arrow_up: Back to top](#index)

Copyright (c) the respective developers and maintainers, as shown by the AUTHORS file.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

All Frameworks and libraries are distributed with it's own license.

**As it is a free(free as in freedom) software. To keep the credit for this works, you should
not remove application footer information text**

**Why AGPL? [Read Here](https://www.gnu.org/licenses/why-affero-gpl.html)**