https://github.com/drkittendorf/employee-tracker
Relational database to track employee information
https://github.com/drkittendorf/employee-tracker
cli inquirer mysql
Last synced: 7 months ago
JSON representation
Relational database to track employee information
- Host: GitHub
- URL: https://github.com/drkittendorf/employee-tracker
- Owner: drkittendorf
- License: mit
- Created: 2020-07-14T15:27:47.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-11-10T23:56:23.000Z (almost 3 years ago)
- Last Synced: 2025-01-25T13:07:29.000Z (9 months ago)
- Topics: cli, inquirer, mysql
- Language: JavaScript
- Homepage:
- Size: 704 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EMPLOYEE TRACKER CLI
(Command Line Interface)
### TABLE OF CONTENTS
- [CONTRIBUTORS](#CONTRIBUTORS)
- [DESCRIPTION](#DESCRIPTION)
- [REFERENCE LINKS](#REFERENCE-LINKS)
- [Dale's EMPLOYEE TRACKER Application :: GitHub Repo](https://github.com/drkittendorf/employee-tracker)
- [LANGUAGES AND TOOLS](#LANGUAGES-AND-TOOLS)
- [CORE PROJECT TECHNOLOGIES](#CORE-PROJECT-TECHNOLOGIES)
- [CORE NODE DEPENDENCIES](#CORE-NODE-DEPENDENCIES)
- [FUTURE DEVELOPMENT](#FUTURE-DEVELOPMENT)
- [LICENSING](#LICENSING)
- [INSTALLING](#INSTALLING)
- [SCREENSHOTS](#SCREENSHOTS-AND-VIDEO)
---
---
## CONTRIBUTORS
Dale Kittendorf
---
# USER STORY
- As a business owner
- I want to be able to view and manage the departments, roles, and employees in my company
- So that I can organize my thoughts and keep track of tasks
- So that I can organize and plan my business
---
# DESCRIPTION
A command-line application that allows the user to:
- Add departments, roles, employees
- View departments, roles, employees
- Update employee roles
- Update employee managers
- View employees by manager
- Delete departments, roles, and employees
- View the total utilized budget of a department including the combined salaries of all employees in that department
---
# REFERENCE LINKS
Link to **Dale's Employee Tracker** deployed on GitHub Pages - [Application Live Link](https://github.com/drkittendorf/employee-tracker)
---
## LANGUAGES AND TOOLS:
---
---
### CORE PROJECT TECHNOLOGIES
Here is a list of all the core technologies used to develop this application.
- `Node.js - An asynchronous event-driven JavaScript runtime`
- `MySQL`
### CORE NODE DEPENDENCIES
The dependencies listed below are all the core NPM packages used throughout the project.
- `inquirer` a collection of common interactive command line user interfaces.
- `table` produces a string that represents array data in a text table.
- `nodemon` automatically restarts the node application when file changes in the directory are detected.
---
## FUTURE DEVELOPMENT
For `future` development, I would like to incorporate the following `enhancements`:
- Add video to readme
- Add screenshot to readme
- Make application run continuously through a loop
- Add a HTML page interface
---
## LICENSING
[](https://opensource.org/licenses/MIT)
The code in this project is licensed under MIT license.
---
## INSTALLING
---
To run this application, follow these steps:
It is a command line application, so will be run in your preferred command line interface:
```
step 1: clone https://github.com/drkittendorf/employee-tracker.git
step 2: install node https://nodejs.org/en/download/
step 3: npm install
step 4: node app.js
step 5: npm start
Follow prompts in command line.
```
---
## SCREENSHOTS AND VIDEO
- ### SCREENSHOT(S)
(TBD)
- ### VIDEO
(TBD)
---