Attendance Tracker

Attendance Tracker is a web application designed to help manage and track attendance for various events and classes. The application is built using a combination of technologies including JavaScript, Blade, PHP, Docker, Hack, and CSS.

Table of Contents

• Project Screenshots
• Features
• Built With
• Installation Steps
• Contribution Guidelines
• Support
• License
• Acknowledgements

Documentation

For more detailed information, you can refer to the project documentation.

Project Screenshots:

🧐 Features

Here are some of the project's best features:

• User authentication and authorization
• Attendance tracking and reporting
• QR System
• Event management
• Notifications and reminders
• Easy Installation

💻 Built With

Technologies used in the project:

• Laravel
• Livewire
• Filament PHP

🛠️ Installation Steps

1. Clone the repository:

   git clone https://github.com/ker00sama-dev/AttendanceTracker.git

2. Install dependencies:

   composer install 
   npm install

3. Set up the environment variables by copying the .env.example file to .env and updating it with your configuration:

   cp .env.example .env

4. Generate an application key:

   php artisan key:generate

5. To start the application use the following command:

   php artisan serve

🍰 Contribution Guidelines

We welcome contributions to the Attendance Tracker project! By contributing, you can help improve this project and make it more useful for everyone.

How to Contribute

1. Fork the Repository: Click on the "Fork" button at the top right of this page to create a copy of this repository in your own GitHub account.
2. Clone the Repository: Use the following command to clone the forked repository to your local machine:

   git clone https://github.com/your-username/AttendanceTracker.git

3. Create a Branch: Create a new branch for your feature or bug fix:

   git checkout -b feature-or-bugfix-name

4. Make Your Changes: Implement your changes in the new branch.
5. Commit Your Changes: Commit your changes with a clear and descriptive commit message:

   git add .
   git commit -m "Description of the changes"

6. Push to Your Fork: Push your changes to your forked repository:

   git push origin feature-or-bugfix-name

7. Create a Pull Request: Go to the original repository and create a pull request (PR) from your forked repository and branch.

Code Style

Please ensure your code follows the project's coding standards and conventions. We use PSR-12 for PHP code and ESLint for JavaScript code.

Reporting Issues

If you find a bug or have an idea for an improvement, please open an issue on the Issues page. Provide as much detail as possible to help us understand and address the issue promptly.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Thank you for contributing!

Support

For support, please open an issue on the Issues page or contact the project maintainers.

License

This project is open-sourced software licensed under the MIT license.

Acknowledgements

• Laravel
• Bootstrap
• Font Awesome