This application allows users to manage a database of employees. Information includes employee id, name, role, department, and salary information. New employees, departments, and roles can be added as needed. It also displays all employees with their information in a tabular format. This app is CLI-based and uses node.js, JavaScript, Inquirer, mySQL, dotenv, and ascii-art.
After cloning the repository, install necessary dependencies by adding the following items to you package.json file and running npm i:
"asciiart-logo": "^0.2.6",
"console.table": "^0.10.0",
"dotenv": "^10.0.0",
"express": "^4.17.1",
"inquirer": "^8.1.2",
"mysql2": "^2.3.0",
"sequelize": "^6.6.5"
NOTE: You may also want to add node_modules to your .gitignore file to prevent unnecessary library uploads to your repository.
Database Setup:
- Create the database by running the contents of the
schema.sqlfile inmySQL. - Seed the database by running the contents of the
seeds.sqlfilemySQL.
After pulling down the repository, you must create a.env file in the root directory and complete the below required environmental variables you chose when you setup your database.
DB_HOST=<usually localhost>
DB_USER=<username to connect to database>
DB_PASS=<password to connect to database>
DB_NAME=<name of database>
DB_PORT=<port to connect to database>
When that is complete, start the app by running npm start in your terminal or CLI. Then, use the arrow keys to select an option and press ENTER. Complete the prompts and continue to choose other options until you are finished. At that time, you can exit the app by choosing QUIT.
This project is licensed under License: MIT
To contribute to this project (or any others), please contact me using the information in the Questions section below or by submitting a pull request.
For more information on project contribution guidelines, please reference Contributor Covenant
If you have any questions, please feel free to reach out. Thanks!
GitHub: https://github.com/matthewbush55
Email: [email protected]