###Project Title: TaskHub ###Project Team: Justin Alvey, Sean O'Neal, Brandon Spitler, and Lucy Wilkinson
A social media-type system for work that allows managers to send task requests to employees. keep track of employee performance based on task history
A centralized system that comprehensively tracks employee performance through task completion history
To track employee performance for companies with a large number of employees and optimizing task-tracking in the workplace
- TaskHub is run locally for now, but TaskHub.site will be coming soon! Make sure to be watching.
- TaskHub utilizes the popular LAMP stack: Linux, Apache, MySQL, and PHP for software development
- XAMPP was used to develop TaskHub, and is a free and open source cross-platform web server solution stack package developed by Apache Friends (they are super awesome and you should check them out)
- TaskHub is also equipped to run on Windows and Mac OS X (see Deployment Environment Setup - Your OS below)
- From the Xampp Control Panel, Apache and MySQL must be running
- MySQL databases are managed from phpMyAdmin
- The TaskHub webframe was tested on Xampp, v3.2.2. To download Xampp, go to this website and download Xampp or follow the first steps in this tutorial video
- Now that we have Xampp, open up the Xampp control panel (this might be located in your downloads, or you can search in your programs list)
- From the Xampp Control Panel, make sure the Apache and MySQL modules are running by clicking the "Start" button under Actions for each. If the buttons immediately under Actions say "Stop", then they are already running and you don't have to change anything else
- Let's setup the database for the site. Open a web browser, and type in localhost/phpmyadmin/. This will navigate you to the phpmyadmin setup included with Xampp, with which you can manage database(s) effectively
- Now create a database called taskhub, which we will use for this project. Download the sql file from our github: loadDB2.sql, and navigating back to phpmyadmin, select "Import" from the top toolbar and upload the SQL file. At this point, all tables will be loaded for testing via the SQL queries. Including are the users table where employees and managers login information is kept, the InProgress table which reflects the current tasks being worked on by employees, and the CompletedTasks table which reflects the taks that have been completed and have been graded by the managers.
- Navigate back to the TasHub github repo, and download/clone the files
- Here is where the distinction between Operating Systems comes in. We are going to move the project files into a different location. Navigate to your C-drive, and lick on the folder named "xampp." From here, click on htdocs. Now, unzip the project files folder if you haven't already, and place in the htdocs folder directory. From here, the localhost can be run on your machine.
- To test it out, run localhost/3308-project-master/, and you should see the welcome page for TaskHub with a sign-in form. Make sure to sign up, and then you will be redirected to your dashboard
- Note: Once the database is set up, there is really no need to use phpmyadmin - other than to use what is going on behind the scenes. If you are interested you can have a look, but it is not need beyond this point.
- The TaskHub webframe was tested on Xampp, v3.2.2. To download Xampp, go to this website and download Xampp or follow the first steps in this tutorial video
- Xampp can be installed in a short series of steps using the command line. For download instructions on Linux, see this FAQ page and click "How do I install XAMPP?" for the steps required.
- If you have problems suchs as a predefined password for user root there are two files you need to change include/connection.php and function/function.php-change the empy quotation marks to "\whatever your passswordis"
- The TaskHub webframe was tested on Xampp, v3.2.2. To download Xampp, go to this website and download Xampp or follow the first steps in this tutorial video
- Xampp can be installed by following the short list of steps at this FAQ page by clicking "How do I do install XAMPP for Mac OS X?" and following the steps.
This repo includes a lot of code, and many different avenues are taken to create the TaskHub software what it is. Included are CSS style pages, custom Javascript code for site functionality, Bootstrap framework packages included to create sleek design, and sql queries which are used to manage databases. But the code can be broken down further. Here is a comprehensive breakdown of all code and files used in TaskHub.
-
####CSCI 3308 Required Project Files 1. Part 1: ProjectPart1.pdf provides a "look-ahead" approach to our project, including our project-tracking software (Trello), VCS (GitHub), and our project description. 2. Part 2: 03-TaskHub_Part2.sql is a MySQL dump of our first database tables. Provided a visual interpretation of how our database would function, and using phpMyAdmin, was detrimental in providing function for our project 3. Part 4A: TaskHub_Part_4Testing.pdf is a breakdown of the method by which we tested our code. Using automated test cases, we were able to find which areas of our backend needed improvement, by testing user functions such as signing in, updating a task, and others. 4. Part 4B: TaskHub_Part_4Autodoc.pdf is an autodocumentation of our code, by which other users and programmers can experience our thought process, and witness the method involved. We hope by making our code open-source and free, we can help other programmers and thinkers solve problems at even the smallest scale of programming. 5. Part 4C: TaskHub_Part_4Finish.pdf provides an overview, and "looking back" view of our project to see what was contributed, what worked with our software process (Trello, GitHub, developing source, etc.) and what product we were able to create as a final product (Demo Video.) 6. Part 5: TBD 7. Part 6: Not included - individual peer evals 8. Other: project1.sql was a testing of our mysql database setup using queries
-
####TaskHub Full Source 1. index.php - loads in the connection.php file from its directory (/includes), header.php, and eventually login.php 2. /includes/connection.php - using SQL query, establishes a connection to the database through the localhost 3. /template/header.php - loads the homepage styling (html and css, mostly bootstrap with some scss and js for functionality), allows new users to create an account (calls insert_user.php), and allows returning users to log back in to see their tasks (login.html) 4. /img folder - holds images for the site (homepage background, included in DISCLAIMERS readme) 5. /fonts folder - keeps fonts and glyphicon symbols for site use 6. /font-awesome - provides numerous font possibilites to use for the site, including use on the login page 7. /css folder - included all bootstrap styling we need for the home page 8. /scss folder - includes style written in scss instead of css for the sign-up/login form 9. login.php - when a user logins into their account, this file takes their email and password attempt and check them against the database. If the user has a correct email and password coombination, then the user is greeted with a "Successful Login" and sent to their dashboard page 10. user_insert.php - when a user signs up for an account, this file takes their login information and checks it against the database to make the sure the user hasn't already registered. If the user has already registered, then they are warned by this and asked to use another email. If the user has not already registered using that emailm then they are given a random employment key and their information is stored in the database. They are then redirected to home.php, which is the dashboard page for all users. 11. home.php - the dashboard home page for all users. From here, they can review their current tasks, review their task history and task grades, sent out enrollment keys to the employees beneath them if they have them, and then review the tasks they have sent out to their employees. This navigation can be done from the left sidebar, where a page exists for each feature. To review your current tasks and past tasks, go to the "Dashboard" tab (home.php), to request enrollment to your supervisor, go to the "Network" tab (network.php), and to review tasks submitted by your employees, grade their tasks, or check tha status of their employees current tasks, go to the "Manager" tab (tasks_sent_dash.php.) Also, the home.php dashboard page makes use of many more folders and style sheets. 12. /bootstrap folder - includes separate bootstrap styling for the dashboard components, including the calendar, task module, and task labels. 13. /dist folder - includes images for default user images and javascript code which enables drop-down menu functionality and task reordering by the user. 14. /pages folder - includes html for the calendar and widget applications to the dashboard for future use, along with html for more advanced applications (mailing mechanism, automatic chat, etc.) 15. /functions/function.php - location for future function calls, and a redundant server connection 16. /js folder - jQuery and other javascript functions used along with bootstrap for site functionality 17. /plugins folder - a wide assortment of custom javascript and css, meant to be use for future projects 18. /styles folder - a folder with styling for specific tables and list items for the dashboard page 19. addingTaskPopUp.php - from either the "Dashboard" tab (home.php) or "Manager" tab (tasks_sent_dash.php), new tasks can be sent by managers to their employees. When this button is clicked, the file addingTaskPopUp.php loads for the user and displays an input form. The manager can input the elements of a task (employye responsilbe, description, difficulty, and date) and then press "Send" which will link the employee to that task, and will appear on their dashboard. 20. insert_emp.php - is called from the "Network" tab of the dashboard (network.php), when an employee requests enrollment. The employee must enter their unique enrollment key, and then their request will be sent to their manager. The manager can either choose to accept or deny this request to join their team. If their boss chooses to accept, they will be linked in the database. This file updates the network. 21. emp_req.php Continued ... But the employee can only send a request once, to prevent spamming their boss. "Emp_req.php" checks to see who has asked for employment, and adds their name to the list of employees awaiting to hear back from their boss. 22. editTask.php - from the "Dashboard" page, an employee may edit the task he or she is working on to reflect their progress. By clicking the edit task button on one of their tasks, a separate html page loads, and allows the user to update the progress so far, or mark the task as done. Done tasks are then sent to the CompletedTasks table in the database, and loaded in their manager's task history to grade. 23. change_grade.php - from the "Manager" tab, a manager can grade the work of their employees. This function gets called in this instance, and updates the task in CompletedTasks to reflect the new grade.
1. Download the last version of Firefox and Selenium
2. Recreate an empty taskhub table. (probably wont matter but just in case you created the same users as me)
3. Using "loadDB2.sql" copy into the tables then run the testing script clicking okay on the pop up windows
4. using one of the following selenium source files go to edit new test case and copy and paste that source into the source tab or export one of the files as a test Case
a. Test_login.selenium signs up a new user and logs him in
b. Test_everything.selenium logs 3 users in making two of them the manager of one then one of the managers assigns tasks to the employee; that employee then edits the tasks progress, then completes task; finally it swings back into the manager to give that employee a grade for that task.
c. Test_signup.selenium signs user 3 in
4. Run those scripts using Selenium and Firefox and play current test
5. Press okay to the pop up alerts