employeeTracker
employee-tracker
Employee Tracker README
Welcome to the Employee Tracker README, a great spot to get to know this project!
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
About The Project
I was tasked to create a employee tracker app so that a business owner can: Can view and manage the departments, roles, and employees in my company SO THAT I can organize and plan my business
GIVEN a command-line application that accepts user input WHEN I start the application THEN I am presented with the following options: view all departments, view all roles, view all employees, add a department, add a role, add an employee, and update an employee role WHEN I choose to view all departments THEN I am presented with a formatted table showing department names and department ids WHEN I choose to view all roles THEN I am presented with the job title, role id, the department that role belongs to, and the salary for that role WHEN I choose to view all employees THEN I am presented with a formatted table showing employee data, including employee ids, first names, last names, job titles, departments, salaries, and managers that the employees report to WHEN I choose to add a department THEN I am prompted to enter the name of the department and that department is added to the database WHEN I choose to add a role THEN I am prompted to enter the name, salary, and department for the role and that role is added to the database WHEN I choose to add an employee THEN I am prompted to enter the employee’s first name, last name, role, and manager, and that employee is added to the database WHEN I choose to update an employee role THEN I am prompted to select an employee to update and their new role and this information is updated in the database
Built With
Below are the following technologies and applications utilized to help build the project.
VS Code
JavaScript
Node
MySQL2
Inquirer
Getting Started
Below you’ll be able to see screen shots of the deployed app. You can also view the road map to see how you can test it locally.
Usage
Here’s a video tutorial on how to use the app:
View Tutorial
Here’s a screen shot of what the app looks like when someone starts it.
Roadmap
- Start the application
- Choose to view all departments and a formatted table showing department names and ids triggers
- If view roles is selected, a user will be able to view job title, role id and the department tha tthe role belings to
- Can instead select view all employees and user is presented with:
- Employee data
- Employee ID
- Salary
- A user can add a role with department id and salary
- A user can view all departments with updated changes
See the open issues for a full list of proposed features (and known issues).
Contributing
I strongly feel that contributing well throught and engaging suggestions are instrumental. I am an avid learner and want to let you know any contribution or suggestions are apprecaited.
If you truly believe you can contribute to making this website better, please fork the repo and create a pull request. If you do not wish to fork, you can open and create an issue with the tag “enhancement” or “suggestions”. I will then be able to review it and take it into consideration. Lastly, please don’t forget to give the project a star!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/newSuggestion) - Commit your Changes (
git commit -m 'Add some NewSuggestion') - Push to the Branch (
git push origin feature/NewSuggestion) - Open a Pull Request
License
Distributed under the MIT License.
Copyright (c) 2022 Dan Poggetti
See License.text for more information.
Contact
Dan Poggetti - GitHub [https://github.com/danpoggetti]
Project Link: [https://github.com/danpoggetti/employeeTracker]
Demo Link: [https://danpoggetti.github.io/employeeTracker/]
Acknowledgments
I want to acknowledge the many great and vast resouces that adided us in creating this weather dashboard app.