H-Notes is a web application developed using Laravel, Breeze, Vite, and MySQL that allows school administrators to manage teachers, modules, students, and notes, and teachers to manage students' exam marks, and students and parents to view their progress and attendance.
- Admin Dashboard: The admin dashboard allows school administrators to manage teachers, modules, and students.
- Teacher Dashboard: The teacher dashboard allows teachers to manage their students' exam marks.
- Student Dashboard: The student dashboard allows students and parents to view their progress and attendance.
- Authentication: The application uses Laravel Breeze for authentication.
- Database: The application uses MySQL as the database.
To install the H-Notes application, follow these steps:
- Clone the repository:
git clone https://github.com/reda-benmakdad/h-notes.git
- Install the dependencies:
composer install
npm install
- Create a
.env
file:
cp .env.example .env
- Generate an application key:
php artisan key:generate
- Set up the database by editing the
.env
file:
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=h-notes
DB_USERNAME=root
DB_PASSWORD=
- Run the database migrations:
php artisan migrate
- Compile the assets:
npm run dev
- Serve the application:
php artisan serve
- Visit the application in your web browser at http://localhost:8000.
To use the H-Notes application, follow these steps:
- Register for an account as an administrator, teacher, or student.
- Log in to your account.
- Navigate to your dashboard to manage your users, modules, or marks.
If you would like to contribute to the H-Notes application, please follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b my-feature-branch
. - Make your changes and commit them:
git commit -am 'Add some feature'
. - Push to the branch:
git push origin my-feature-branch
. - Submit a pull request.