School Management

This is a simple school management application built with Laravel.

Important

This project is in beta stage and is not yet ready for production use. This first version is still under development and may contain bugs or incomplete features.

Installation

1. Clone the repository:

   git clone https://github.com/albertlnz/school-management.git

2. Change directory:

   cd school-management

3. Install dependencies:

   composer install

4. Change the .env.example file to .env and setup your BBDD configuration

   4.1 Configuration using SQLite:

   DB_CONNECTION=sqlite
   # DB_HOST=127.0.0.1
   # DB_PORT=3306
   # DB_DATABASE=school_management
   # DB_USERNAME=root
   # DB_PASSWORD=
   

   4.2. Configuration using MySQL or MariaDB:

   DB_CONNECTION=mysql
   DB_HOST=127.0.0.1
   DB_PORT=3306
   DB_DATABASE=school_management
   DB_USERNAME=root
   DB_PASSWORD=
   

   *Notices that per default, Laravel 11 use SQLite, but you can change by MySQL or MariaDB.

5. Do the database migrations:

   php artisan migrate

6. If you want, you could execute the seeders generated by Faker:

   php artisan migrate:fresh --seed

7. Start the development server:

   php artisan serve

8. Open your browser and visit http://localhost:8000

Usage

API Documentation

The API documentation is available at http://localhost:8000/api/documentation.

Database

The database is stored in the database directory.