This project is an approach to an employees management application that could be used in a comany to keep records of their employees. It is developed using an MVC architecture and object-oriented programming, and is a refractor of a previous project developed with procedural programming, where we updted the whole structure and added some new functionalities.
- Session login and logout
- Login as user or admin
- Admin has rights to create new users
- Controlled user session set to 10 minutes
- Show data from database in JSGrid (both for employee records on "dashboard" page, and user records on "users" page)
- Pagination of the data configured by the grid
- Employees and Users CRUD (Create Read Delete and Update) synchronized with database
- Employees and Users CRUD managed with both PHP and JS ajax
- Employee page with employee detail and the ability to update its data
- User page with user detail and the ability to update its data
- Connection with external api to get avatars and set them as employees profile image on the "employee" page
The project's file structure is the following:
- Assets: contains css, js & images
- Assets/js: contains ajax crud methods and JSGrid configuration
- Config: contains a config.php file with the definition of the URL path and DB constants ( ignored by .gitignore, needs to be configured locally)
- Controllers: contains controllers for dashboard, errors, login and users
- Libs: contains controller, database, model and view base classes, as well as the app class (this is the entr point of the application) and the connection to the avatars API
- Models: contains models for login, dashboard and users
- Resources: contains a sql file with the DB configuration
- Views: contains all application views
You will need to npm install the following dependencies in order the project to work properly:
As we explained in the pdf document of this project we will use this images api
This web service in the version free that is which we are going to use has limitations. Five request per minute or thirty in an hour.
So if you want to develop this extra feature it would be cool to have a mocked response to develop at ease. So for this purpose we left in resources/ folder a file called images_mock which can be used to the implementation of the extra feature once you have your code running well you need to remove this mock and to connect directly with the web service.
For contributions, please fork the project, change whatever you want and create a pull request with the new content.
- Verónica Velázquez - vvelazquezc
- Irati Arrieta - iarrieta90
This project is under GNU license
⌨️ with ❤️ Verónica Velázquez and Irati Arrieta, based on the employee Management v1 project by Anna Troyan and Froilán Olesti