https://github.com/richardzhang01/employee-tracker

A simple command-line application utilizing Inquirer to manipulate a SQL database
https://github.com/richardzhang01/employee-tracker

inquirer mysql node-js sql

Last synced: about 2 months ago
JSON representation

A simple command-line application utilizing Inquirer to manipulate a SQL database

• Host: GitHub
• URL: https://github.com/richardzhang01/employee-tracker
• Owner: RichardZhang01
• Created: 2022-06-16T20:26:37.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-06-20T14:56:06.000Z (about 4 years ago)
• Last Synced: 2025-12-13T22:25:52.918Z (7 months ago)
• Topics: inquirer, mysql, node-js, sql
• Language: JavaScript
• Homepage:
• Size: 405 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Employee Tracker

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) 

## Description

- My motivation behind this project was to integrate a MySQL database into a command line application. 

- I built this project to better understand SQL logic.

- This project aims to create a command line application which, through the use of Inquirer, allows the user to interact with a MySQL database, performing a variety of functions.

- Through this project, I learned a lot about SQL logic, how to join tables together, how to filter data, and how to integrate that with user input.

## Table of Contents

1. [Installation](#installation)

2. [Usage](#usage)

3. [Video Demonstration](#video)

4. [License](#license)

5. [How to Contribute](#how-to-contribute)

6. [Questions?](#questions)

## Installation

**Note**: This application requires the use of [Node.js](https://nodejs.org/en/) and [MySQL](https://www.mysql.com/)

To install this project, you first need to clone this repo. To install dependencies, open in [Visual Studio Code](https://code.visualstudio.com/), and in the terminal run: 

      npm install 

Alternatively, you can navigate to the application's installation location in [Git Bash](https://git-scm.com/downloads) (or similar command-line tool) and do the same.

To create the database, in the terminal start MySQL by running:

      mysql -u root -p

Then create the database by running:

      source ./db/schema.sql;

      source ./db/seeds.sql;

## Usage

**Note**: Before running the app, first open index.js and add your MySQL password to line 47. 

Once the application is opened in Visual Studio Code, or navigated to using Git Bash (or similar command-line tool), run: 

      node index.js 

## Video Demonstration

The full video demonstration can be found [here](https://drive.google.com/file/d/1akaXlDVAALUGOg0UpZPiW7CJCMMjRKeb/view)

![Screenshot of the command-line using the app](./assets/images/screenshot-1.png)

![Screenshot of the command-line using the app](./assets/images/screenshot-2.png)

## License

This application is covered under the [MIT](https://opensource.org/licenses/MIT) license

----------------------------------------------------------------

  Copyright © 2022 Richard Zhang

  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.

  ----------------------------------------------------------------

## How to Contribute

If you want to contribute to this project and make it better, your help is very welcome. This was a school project, so anything you want to do to it, go for it. You can also contact me directly through the links below.

## Questions?

Have any questions? Here is a list of my links:

- GitHub: [RichardZhang01](https://github.com/RichardZhang01)

- Email: richardzhiyuanzhang@gmail.com