A command line frontend for managing an employees MySQL database. A video demonstration of this application can be found on YouTube.
Functionality includes:
- Adding a department, employee, or role
- Deleting a department, employee, or role
- Listing all departments, employees, or roles
- Listing a department's employees
- Displaying a department's budget
- Displaying an employee's direct reports
- Changing an employee's manager
- Changing an employee's role
This application requires Node.js and npm to run. To run this application, download the code to your computer via a git clone or a zip download.
Navigate to that directory and run npm install to install all dependencies.
To create the database, run db/DeploymentScript.sql.
To seed the database, run db/seeds.sql.
This application can be used to create, manage, and interface with an employee database.
Make sure to run the database deployment script located at db/DeploymentScript.sql before running the application.
Run the program by executing npm run start or node index.js.
This program uses the PASSWORD environment variable as the password to connect to a database. npm run start will automatically set the PASSWORD environment variable to whatever is specified by the script in package.json and start the application. Otherwise, make sure to set the variable before trying to run this program.
Although this application is no longer under active development, I welcome any and all pull requests from those who would like to contribute to and improve this software.
This software currently does not have any tests.
- What packages does this project use?
- Inquirer for user input
- MySQL2 for handling the database connection
- console.table for printing the data to the console
- run-script-os for creating cross-platform start scripts
Shout out to the people at Doc Gov for having a post showcasing how to create cross-platform NPM scripts.
MIT License
Copyright (c) 2022 kurtbixby
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.