https://github.com/fdeaquino/employee-tracker
https://github.com/fdeaquino/employee-tracker
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fdeaquino/employee-tracker
- Owner: fdeaquino
- License: mit
- Created: 2022-10-30T22:03:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-04T02:22:03.000Z (over 2 years ago)
- Last Synced: 2024-12-28T16:31:52.241Z (6 months ago)
- Language: JavaScript
- Size: 2.29 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Employee Tracker
## Description
This command-line application helps the user (business owner) keep track of important information about their business such as departments, employees and job titles. Additionally, this application lets the user add a department, new roles, and new employees.
In the future, I plan to make this application more functional by adding more features:
- update employees
- delete departments, roles and employees
- update employee managers
- view employees by departments and managers
- view the total utilized budget of a department (view combined salaries of employees by department)
In order to build this application, I used skills such as `inquirer`, `MySQL`, and `mysql2` among others. The biggest challenge I faced in this project was setting up the prepared statements to add and update tables.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Credits](#credits)
- [License](#license)
## Installation
To use this application you will need to clone this repository into your local machine. Then, using the terminal you will need to run `npm install` to install the npm packages/dependencies. To begin using the application, you will need to run `npm start`. Follow the user prompts in the terminal.
## Usage
Please follow [this video guide](https://drive.google.com/file/d/1UPwQC8bYgik5BaN1-O3i2dKIZDl1ylvP/view?usp=sharing)
for using the Employee Tracker or follow the steps below.
## Credits
While creating this project, I read documentation on node.js, inquirer, jest, bootstrap, and Javascript ES6. Additionally, I recieved feedback and support from my 2U tutor.
- [MySQL documentation](https://coding-boot-camp.github.io/full-stack/mysql/mysql-reference-guide)
- [npm inquirer version 8.2.4 Documentation](https://www.npmjs.com/package/inquirer/v/8.2.4#documentation)
- [npm MySQL2 Documentation](https://www.npmjs.com/package/mysql2#documentation)
## License
[MIT](https://spdx.org/licenses/MIT.html)