sql-employee-tracker
sql-employee-tracker 📝
Description 📄
An employee tracker app with Node.js, leveraging the power of Inquirer, MySQL2, and Dotenv dependencies. This sophisticated application is designed to enable intuitive data interaction through a user-friendly interface.
Through Inquirer-powered prompts, users can intuitively create, read, update, and delete records within these tables.
The MySQL2 library seamlessly bridges the gap between the app and the MySQL database, ensuring data integrity.
Dotenv is employed to securely manage sensitive configuration data, such as database credentials, away from the source code. This practice contributes to a more robust and secure architecture.
Built on modern ES6 concepts, the app employs smart coding practices to streamline processes. It effectively manages data across three interconnected tables: departments, employees, and roles. The integration of these components ensures both accurate data representation and efficient data manipulation.
Table of Contents
- Installation 🛠️
- Usage 📘
- Contributing 🤝
- Tests 🧪
- License 📜
- Credits 🙏
- Questions ❓
- Deployed Application 🚀
Installation 🛠️
To install the necessary dependencies, run the following command:
npm i
npm install inquirer@8.2.4
npm install dotenv@8.2.0
npm install mysql2@2.2.5
Usage 📘
- Install Visual Studio Code to run the application.
- Install the NodeJS library.
- Download MySQL to create a database.
- Install the inquirer dependency to ask questions in the terminal.
- Install mysql2 dependency to create a connection with the MySQL database.
- Install dotenv dependency to use environment variables and secure your database password.
Following is a video demonstrating how to run the application in the terminal. 🎥
Contribution 🤝
Knowledgeable users can assist in identifying potential security vulnerabilities or best practices to enhance the app’s security. Skilled users can contribute code changes to fix bugs, optimize performance, or implement new features.
Tests 🧪
To run tests, run the following command:
node index.js
License 📜
This project is licensed under The MIT License. Here is the link to the license to access more information for your reference: https://opensource.org/licenses/MIT
Credits 🙏
I utilized the study material provided by the institution as a reference to complete my application.
Following are the documents I used to help me write code:
- MySQL documentation on installing and starting MySQL
- MySQL documentation on executing SQL statements from a text file
- MySQL documentation on creating and selecting a database
- MySQL documentation on SELECT
- MySQL documentation on INSERT
- MySQL documentation on DROP DATABASE
- npm documentation on MySQL2
- MySQL documentation on data types
- MySQL Docs on Aggregate Functions
- Inquirer package
- MySQL2 package
Questions ❓
If you have further questions, you are welcome to reach me through my email at hazkeel27@gmail.com.
You can view my projects by going through my GitHub profile at https://github.com/hazkeel27.