injury management system `IMS`

A system to record, manage and process on duty injuries

Table of Contents

1. About The Project
   • Project Scope
   • Project Design
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Contributing
3. License
4. Contact
5. Acknowledgments

About The Project

Project Scope

An injury management system (IMS) is a documented description of detailed steps to be followed in a workplace injury case. It incorporates the employer, the medical team, and the insurance. These parties ensure that affected workers regain from injuries as soon as possible and return to work. It provides safe and timely support to workers in case of illness or injury while on duty. Injury management systems will differ depending on the working environment and the industry in which the company is operating. Any organization with employees IMS and an effective return to work program. An injury management system will commonly feature an Incident from, Hazard Identification, Near Miss Reporting and Hazard Reporting.

System should be able to do the following:

• Users should be able to create and manage there accounts
• User should be able to enter records of an injury including taking claimants personal info
• User should also record claimants doctors reports as proof for injury
• After processing the records claimant should be able to get paid

Project Design

Architecture

MVC (Model-View-Controller) is an architectural design pattern that encourages improved application organization through a separation of concerns. It divides an interactive application into three components: Model / View and Controller. It enforces the isolation of business data (Models) from user interfaces (Views), with a third component (Controllers) traditionally managing logic, user-input and coordinating both the models and views. The goal of MVC is to help structure the separate the concerns of an application into three parts:

1. Model

   • The model is the layer that keeps data for the application. The layer is responsible for storing and retrieving data from the database, and it is also responsible for validating the data.

   For example, if you want to create a new user, you will have to create a new user model and save it to the database.

2. View

   • It is the layer used to present the application. It is used to display the data to the end-user.

   For instance, if you want to create a user view, you will have to create UI components that the user interacts with, such as a login form in an easy-to-understand format.

3. Controller

   • The controller is the logic layer of the application. It is responsible for processing the user’s request and generating the response. It links the view and the model.

MVC Sequence Diagram

Suppose an application that let you search for persons. The UI must have a text field where the user can enter a search string, and it might have a button to start the search. Finally, it must have an area where the search results are displayed. In our case, it is implemented with a list component.

The Search for Persons use case Scenario is:

• The user enters a search string in the text field
• The user clicks the search button.
• The search result is displayed in the result list.

The sequence diagram above shows how the user’s button click moves through the application until the result gets finally displayed in the list component.

UML Diagram

Above is the UML design of the system including relationships between the difference objects that make up the system

Built With

Used PHP, JavaScript, HTML, CSS and MySQL.

(back to top)

Getting Started

Prerequisites

You should have the below software installed in your pc :

• PHP 8
• xampp 8
• MySQL
• and your preferred IDE or text editor

Installation

1. Get a free API Key at https://github.com/settings/tokens

2. Clone the repo

   git clone https://github.com/kudzaiprichard/injury-on-duty-management

3. Make sure you copy the project to

   c:/xampp/htdocs
   

4. Open project in IDE or text editor

5. Run xampp and start apache and mysql

6. Create and import database in php my admin

NB: To run the system, open desired browser and on the url bar write localhost/system-folder-name

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

🔥 Contribution

Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project.

1. Report a bug
   If you think you have encountered a bug, and I should know about it, feel free to report it here and I will take care of it.

2. Request a feature
   You can also request for a feature here, and if it will viable, it will be picked for development.

3. Create a pull request
   It can't get better than this, your pull request will be appreciated by the community. You can get started by picking up any open issues from here and make a pull request.

If you are new to open-source, make sure to check read more about it here and learn more about creating a pull request here.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Kudzai P Matizirofa - linkedin.com/in/kudzai-prichard - kudzaiprichard@gmail.com

Project Link: https://github.com/kudzaiprichard/injury-on-duty-management

(back to top)

Acknowledgments

list of resources I found helpful and would like to give credit to.

• Choose an Open Source License
• MVC Framework - Introduction
• PHP Documentation
• GitHub Pages
• MySql docs

(back to top)