Employee Tracker

Description

This project is a command-line application that allows a company to manage its employee database using Node.js, Inquirer, and PostgreSQL. Users can view, add, and update departments, roles, and employees through a simple CLI interface.

Table of Contents

• Installation
• Usage
• Screenshots
• Walkthrough Video
• Contributing
• Contributors
• Tests
• License
• Questions

Installation

To install and set up the application, follow these steps:

1. Git clone: git@github.com:Treevyy/Employee-Tracker.git

2. Navigate to the project directory: cd EMPLOYEE-TRACKER

3. Right click the root package.json file and click open in integrated terminal

4. Inside the terminal install the dependencies with the command: npm i

5. After dependencies are installed run the application with the command: node index.js

Usage

Run the application with the following command: node index.js These commands will allow you to see real time employee, manager, departments and salaries inside your company. It also allows you to update, modify, or delete current employees, managers, departments, roles and salaries with the option to exit each function if you accidnetly misclick into any of these choices.

Upon starting, you will be presented with a menu to:

1. View all departments

2. View all roles

3. View all employees

4. Add a department

5. Add a role

6. Add an employee

7. Update an employee role

8. Update an employee manager

9. View employees by manager

10. View employees by department

11. View the total utilized budget of a department

12. Delete a department

13. Delete a role

14. Delete an employee

15. Exit

Screenshots

Walkthrough Video

A demo of the application can be found at the following link: https://drive.google.com/file/d/1Yy7Q0Lm3xgsRqM9El3YWAKM819-TaMqM/view

Contributing

Contributions are welcome! If you would like to contribute to this project, please follow these steps:

1. Fork the repository

2. Create a new branch (git checkout -b feature-branch)

3. Commit your changes (git commit -m "Add new feature")

4. Push to the branch (git push origin feature-branch)

5. Open a pull request

Contributors

All of these tutors helped me revise and edit my code to function properly during the tutoring sessions. Thank you for all your help!

1. Treevyy aka Trevor Moore the main contributor to the assignment.

2. Ainsley Tutor

3. Luis Tutor

Tests

Currently, no automated tests are available.

License

This project is licensed under the MIT license.

Questions

If you have any additonal questions, you can contact me at:

• GitHub: Treevyy

• Email: aarontrevormoore@gmail.com