[Unit 12, SQL - Employee Management System Assignment]

This is a command-line application that manages a company's employee database using Node.js, Inquirer, and MySQL.

It follows a content management systems (CMS) interface that allows non-developers to easily view and interact with information stored in the database.

The application has the following appearance:

A walkthrough video that demonstrates the features and functionalities of this employee tracker can be viewed by clicking the following links:

• Part 1, View and Add Functionalities

• Part 2, Update an Employee's Role

• Part 3, Update an Employee's Manager and Delete Functions

• Part 4, View Employees by Manager, Role, and Department and View a Department Budget

The application files can be accessed on my Github repository.

1. Title
2. Description
3. Installation
4. Usage
5. Technologies
6. License
7. Contributing
8. Tests
9. Credits
10. Author
11. Questions

• Clone my repository on GitHub.

• On Visual Studio Code:

  • Open the cloned file.
  • Create your gitignore and .env files.
  • Check the dependencies and dev dependencies needed on package.json.

• To set up all the existing npm packages, run npm init.

• To install the dependencies on the node_modules folder, run npm install or

  • npm i mysql2 to install MySQL2,
  • npm i inquirer to install Inquirer,
  • npm i node to install Node.js, and
  • npm i console.table to install console.table.

• Run MySQL by entering the following:

  mysql -u root -p
  

• Create the schema.sql tables and pre-populate the database with the data found in the seeds.sql files.

• To invoke the application, run

  npm start
  

Please see the walk-through demonstration videos, descripton, and features and functionalities sections.

1. When the user starts the application, the user is presented with the following options:
   • view all departments,
   • view all roles,
   • view all employees,
   • add a department,
   • add a role,
   • add an employee,
   • update an employee role,
   • update an employee's manager,
   • delete a department,
   • delete a role,
   • delete an employee,
   • view employees by manager,
   • view employees by role,
   • view employees by department, and
   • view a department budget.

2. By clicking the correct prompt, a user can view all departments, all roles, or all employees.

View All Departments

3. When the user chooses to view all departments, the user is presented with a formatted table showing department names and department ids.

View All Roles

4. When the user chooses to view all roles, the user is presented with the job title, role id, the department the role belongs to, and the salary for the role.

View All Employees

5. When the user chooses to view all employees, the user is presented with a formatted table showing employee data, including employee ids, first names, last names, job titles, departments, salaries, and managers the the employees report to.

6. A user can add a department, a role, or an employee.

Add a Department

7. When the user chooses to add a department, the user is prompted to enter the name of the department and the department is added to the database.

Add a Role

8. When the user chooses to add a role, the user is prompted to enter the name, salary, and department for the role and the role is added to the database.

Add an Employee

9. When the user chooses to add an employee, the user is prompted to enter the employee’s first name, last name, role, and manager, and the employee is added to the database.

10. A user can update an employee role or manager.

Update a Role

11. When the user chooses to update an employee role, the user is prompted to select an employee to update and their new role, and this information is updated in the database.

Update a Manager

12. When the user chooses to update an employee's manager, the user is prompted to select an employee to update and their new manager, and this information is updated in the database.

13. A user can delete a department, a role, or an employee.

Delete a Department

14. When a user chooses to delete a department, the user is prompted to select the department and this information is updated in the database.

Delete a Role

15. When the user chooses to delete a role, the user is prompted to select the role and this information is updated in the database.

Delete an Employee

16. When the user chooses to delete an employee, the user is prompted to select the employee and this information is updated in the database.

17. A user can view employees by manager, by role, or by department.

(Note: Only rank-and-file employees are shown in the employee list when the employees are viewed by manager or by role.)

View by Manager

18. When the user chooses to view employees by manager, the user is presented with a formatted table showing the (rank and file) employees who report to the said manager, and their data which include their employee ID, first names, and last names.

View by Role

19. When the user chooses to view employees by role, the user is presented with a formatted table showing the (rank and file) employees who perform the said role, and their data which include their employee ID, first names, and last names.

View by Department

20. When the user chooses to view employees by department, the user is presented with a formatted table showing all employees in the said department (i.e., managerial and rank and file) and their employee data which include their employee ID, first names, last names, title, and salary.

21. A user can view the budget of a department.

View a Department budget

22. When the user chooses to view the budget of a department, the user is prompted to select the department and is presented with the total utilized budget of a department, which is the combined salaries of all employees in that department.

1. Javascript
2. MySQL
3. Node.js
4. Inquirer

License used for this project - MIT

For more information on the above license and other license types, please see the following websites:

• Open Source Initiative
• Choose a License

To contribute to this application, please email the author for guidelines.

The application and its functionalities are tested manually using Visual Studio Code.

The following were consulted and used in the development of this application:

• UCI Boot Camp study materials, videos, and internet resources on MySQL, Node.js, and Inquirer.
• Jeff Howell and Mike Scharf for the homework walk-through videos (Thanks for putting them together and sharing them in the meeting room. They are a big help!).
• The grader for my Social Media API assignment, whose comments encouraged me to plow through with my employee tracker app -- an assignment I considered to be one of the hardest and most tedious to do -- and not give up and submit an unfinished work. The grader also taught me the standard that I should keep when writing my README files. Thank you!
• mySQL
• Node.js
• npmjs packages and documentations on MySQL2, Node.js, Inquirer, and Express.js.
• Screencastify

Jane Tiglao

For questions or issues, please contact:

• Jane Tiglao
• Email: [email protected]
• GitHub Username: jbtiglao
• GitHub Profile: https://github.com/jbtiglao