/employee-tracker

This CLI app will generate a team profile following a preset format.

Primary LanguageJavaScriptMIT LicenseMIT

Employee Tracker

This CLI app will generate a team profile following a preset format.
View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contact
  5. Acknowledgments

About The Project

Product Screenshoot

Developers frequently have to create interfaces that allow non-developers to easily view and interact with information stored in databases. These interfaces are called content management systems (CMS). This command-line application is to manage a company's employee database, using Node.js, Inquirer, and MySQL.

(back to top)

User Story

AS A manager
I WANT to generate a webpage that displays my team's basic info
SO THAT I have quick access to their emails and GitHub profiles

(back to top)

Acceptance Criteria

  • GIVEN a command-line application that accepts user input

  • WHEN I start the application THEN I am presented with the following options: view all departments, view all roles, view all employees, add a department, add a role, add an employee, and update an employee role.

  • WHEN I choose to view all departments THEN I am presented with a formatted table showing department names and department ids

  • WHEN I choose to view all roles THEN I am presented with the job title, role id, the department that role belongs to, and the salary for that role

  • WHEN I choose to view all employees THEN I am presented with a formatted table showing employee data, including employee ids, first names, last names, job titles, departments, salaries, and managers that the employees report to

  • WHEN I choose to add a department THEN I am prompted to enter the name of the department and that department is added to the database

  • WHEN I choose to add a role THEN I am prompted to enter the name, salary, and department for the role and that role is added to the database

  • WHEN I choose to add an employee THEN I am prompted to enter the employee’s first name, last name, role, and manager, and that employee is added to the database

  • WHEN I choose to update an employee role THEN I am prompted to select an employee to update and their new role and this information is updated in the database

(back to top)

Built With

The following dependencies/resources have been used:

(back to top)

Getting Started

Prerequisites

  • Node must be installed
  • mySQL must be installed

Installation

  • Install all necessary dependencies
    • Inquirer, dotenv, mysql2, and cli-table must be installed
    • Point the terminal to the main directory and run the following command
    npm start

(back to top)

Usage

  • Point the terminal to the main directory

  • Run the following command in mySQL CLI SOURCE db/schema.sql

  • Quit mySQL command line quit;

  • In command line, run npm run start

(back to top)

Contact

Heran Yang- LinkedIn

Project Link: https://github.com/heranyang93/team-profile-generator

(back to top)

Acknowledgments