The original purpose of this project was to provide an easy solution for college assistants to sign in/out and remove paper usage at the New York City College of Technology’s Ursula Library. The ESS was heavily integrated with the internal web app used at the library. With multiple projects running in one CodeIgniter installation, I needed to do extensive cleanup and editing to allow this project to be open source. This will explain why some files may have just one function, or strange naming conventions, or why some functions may have error handling, while others do not, etc. Some of the ESS capabilities include creating employee shifts, real-time sign-in status, simple employee substitution process, adding anouncements, among others. For full capabilities, please see the attached documentation. I hope you are able to extend this project and make great usage of it.
- Install a server, such as WAMP, or XAMP and run it. This project was built using PHP 5.6.
- Download a copy of CodeIgniter 3 into your servers' web folder and rename it Libservices.
- Make sure you can access your installation of Codeigniter in your browser by going to 'yourDomain'/Libservices.
- Drop the ESS assets folder where your Libservices application folder is located.
- Place all ESS files and folders in their respective Libservices folders.
- Drop the files inside the ESS config folder into your Libservices/application/config folder, replace the files in destination, or edit your originals accordingly.
- Drop the files inside the ESS controllers folder into your Libservices/application/controllers folder.
- Drop the files inside the ESS language\english folder into your Libservices/language/english folder.
- Drop the files inside the ESS library folder into your Libservices/application/libraries folder.
- Drop the files inside the ESS models folder into your Libservices/application/models folder.
- Drop the folders inside the ESS views folder into your Libservices/application/views folder.
- In the ESS sql folder, locate the sql file. The DEFINER for procedures is ‘root’@’localhost’ and you need to change it if you are not using a local server. You can change it by opening the file in your code editor and doing a search/replace accordingly.
- Load the ESS sql file into your database, through the command line, MySQL Workbench or other, making sure to include both structure and data.
- Place the ESS docs folder wherever you can easily access them for reference.
- Head to 'yourDomain'/Libservices/index.php/auth/login to login with barcode 12345 or email: ess@ess.com and password: password.
- Read the docs or use the Help menu located under the username at the top right to use the application.
- Using the documentation, schedule an employee for work, then try to sign in and out at 'yourDomain'/Libservices/index.php/Timesheet/ipadPage
Some functions in the ESS, such as creating a new user, will require a Gmail email to be setup.
- In Application/config folder, change smtp_user and smtp_pass in the emai.php file for emailing to work. The Gmail account used must be allowed smtp requests, although I noticed that creating a new account didn’t create such issue; you may want to do that for testing purposes.
- Also in the config folder, change the ion_auth file’s admin_email to whichever email you want, which will be used for the reply-to function in Gmail if you need it.
- To modify the email content, search for $emailData['title'] in the project and you will find a few instances of that together with the other required pieces
- To show the logo picture, or change it, modify the url in $emailData['titleImgSrc'] to a publicly accessible picture.
- To change the title, modify $emailData['title'].
- To change the body, modify the $emailData['emailBody'].
- To change the footer, modify $emailData[‘helpContact’].
The email template will look similar to this:
- The application will not work without at least one semester in the database. I added a temporary one for you, which you can edit once you login.
- Although I added a user for you of admin level privilege, you can go to 'yourDomain'/Libservices/index.php/auth/index to add more users. This link is found in the application as well as in the add employee section with further information. You will not be able to access this page without a high privilege user logged in.
- Ion Auth files were modified, especially the views. signature_pad was also modified. Take note of this if you wish to update these plugins later on.
- Instead of using the ipadPage to sign in a shift, you can use 'yourDomain'/libservices/index.php/timesheet/ipadPageCA/12345, where 12345 is the employees' barcode. This simplifies the process a bit since there will not be a need to enter the employee's barcode in the ipadPage eacn time.
- The docs folder includes an outline I wrote at one point when we were updating the ESS. It was meant to be an inventory type list of the functionality of the system, which included descriptions for some of the items. It should help you further understand the ESS. The folder also includes a how-to for adding more help menus if you decide to add functionality.
- CodeIgniter Ion Auth by Ben Edmunds
- signature pad by Szymon Nowak
- jQuery.floatThead by Misha Koryak
- jQuery Timepicker Addon by Trent Richardson
- Ursula C. Schwerin Library at the City College of Technology of New York for providing the servers and helping shape the application through usage and recommendations.
- This project is licensed under the MIT License - see the LICENSE.md file for details
