documentation

description.txt

@@ -0,0 +1,11 @@
+- A dynamic web application (web based, functional, fully fledged system) developed as a group project
+- 2nd year 2nd semester group project for the ITP (Information Technology Project) module
+- In this project, our team, which consisted of 8 members, developed a dynamic web application for the Peter's Place Hotel in Hiriketiya, Dikwella, Matara
+- This Hotel Management System includes eight main functions namely, Room Management and Reservation, Employee & Human Resource (HR) Management, Front Desk and Customer Management, Event Management, Supplier Management, Inventory Management, Housekeeping Management and Financial Management
+- Used technology : PHP, Laravel Framework, MVC Architecture, Bootstrap, MySQL, HTML, CSS, JavaScript, JQuery, Git & Github for version controlling
+- Software modeling & designing : UML (Use Case Diagram & Use Case Scenarios, Class Diagram, Sequence Diagrams, Communication Diagrams, Activity Diagrams, State Chart Diagrams)
+- Text editors & IDEs : PhpStorm, Visual Studio Code, Sublime Text 3
+- Web server : XAMPP Server
+- Database design : EER Diagram, Database Diagram, Database Schema, Mapping & Normalization
+- Database administration : phpMyAdmin
+- Functions implemented (Individual contribution) : Room Reservation and Room Management functionalities with all necessary CRUD operations (insert new records, delete records, retrieve and update details of existing records), advanced search functionality, proper navigation with good user experience and attractive & professional system interface, generating several meaningful reports in PDF format, necessary validations for all form inputs, proper error messages and designing and building a responsive, attrative and user-friendly website for customers

readme_guide.txt

@@ -0,0 +1,66 @@
+--------------------
+      ITP_MLB_G9_13
+--------------------
+
+== Installation == 
+
+1. Download & Install XAMPP. (Not needed if you already have PHP installed)
+https://www.apachefriends.org/index.html
+
+2. Download & Install Composer
+https://getcomposer.org/download/
+
+3. Import the Database to MySQL. (Inside the /database/Dump20190927 folder)
+
+4. Open 'peters place' folder and edit the .env file to match your database settings (Username, Password etc.)
+
+5. Open CMD and go to the 'peters place' folder.
+
+6. Run this command.
+	php artisan serve
+
+7. Server will start on your localhost.
+
+	Email:- [email protected]
+	Password:- admin
+
+== Error Fixing == 
+
+If you get an error saying autoload.php is not found, run these commands in the ''peters place' folder.
+	composer install
+
+If you get an error saying server encryption method is different, run these commands.
+	php artisan key:generate
+	php artisan config:cache
+
+== Help ==
+
+If any other errors, please open a new issue on Github. 
+https://github.com/TharindaNimnajith/peters_place
+
+
+
+== Team - MLB_G9_13 == 
+===============================================================================================================
+ |     IT Number         |                                                       Name                                                 |                            Function                                                    |
+===============================================================================================================
+|      IT18143614         |                      Kavindi Gunasinghe U.L.D                                       |         Front office Management                                   |
+---------------------------------------------------------------------------------------------------------------
+|      IT18135862        |                       Wattegedara S.L                                                           |         Event Management                                               |
+---------------------------------------------------------------------------------------------------------------
+ |     IT18140262        |                      Visna Oshani Jayasinghe                                         |        Finance Management                                            |
+---------------------------------------------------------------------------------------------------------------
+|      IT18149654        |                     Rajapaksha T.N                                                               |   Room reservation and Room Management   |
+---------------------------------------------------------------------------------------------------------------
+|      IT18124590        |                     Parana Liyanage T.L                                                     |       Supplier Management                                           |
+---------------------------------------------------------------------------------------------------------------
+|      IT18153682        |                    Gajasinghe A.N                                                                |        HR Management                                                      |
+--------------------------------------------------------------------------------------------------------------- 
+|      IT18093124       |                     D.H.L.Amarasinghe                                                       |        Housekeeping Management                             |
+---------------------------------------------------------------------------------------------------------------
+|      IT18151770        |                     C.A.J.P.Chandranath                                                     |         Inventory Management                                        |
+===============================================================================================================
+
+
+
+Thank you.