/WorkforceOne

Primary LanguageJavaScriptCreative Commons Zero v1.0 UniversalCC0-1.0

👩‍💼 WorkforceOne 🧑‍💼

Employee Management CLI

||WorkforceOne||

license


DESCRIPTION

This application was built to assist an administrator of a company with quickly and easily viewing and updating employee information within the company database, using a minimal, attractive command-line interface.

Table of Contents

(Internal navigation links)

Note: The click-through links contained within the discussion sections may send you to an external site.




  • DEVELOPMENT

What's under the hood?

Application developed using the following tech:

  • dotenv node package to hide sensitive user information
  • inquirer.js to handle prompts and processing of user input
  • mysql2 node package to maintain a connection with the user's MySQL database during use
  • chalk node package to style command line text
  • console.table package for attractive formatting of database tables



  • USAGE

Building your workforce

NOTE: The user should have node.js installed on their local machine, and be familiar with navigating the command line, to harness this application's functionality

Usage steps:

  1. Clone the github repo to your local machine @ WorkforceOne Repo
  2. At the root level of the application directory, inside the terminal, run the command
    npm install
  3. Once all of the necessary packages have been installed, add a file named '.env' at the root level.
  4. Within the '.env' file, initialize three environemntal variables like so, with the user's specific information inside each string:
    DB_NAME='<name of your sql database>'
    DB_USER='<sql username>'
    DB_PASS='<sql password>'
  5. Finally, run this command in the terminal:
    npm start



  • DEMONSTRATION

Check it out

Welcome message and menu


View all tables


Add department


Add role


  • Walkthrough video:

Google drive link to walkthrough video




  • CREDITS

  • SMU Web Dev Bootcamp for valuable knowledge and skills




About the Creator

Joshua Newell Diehl

is a budding developer currently based in Ft Worth, Texas. He enjoys coding, long romantic hours dead asleep, walks with his dog Margot, and creepily referring to himself in third person.

Here are a few of his favorite technologies at the moment:

And here is where you can reach him || review the work he's been doing:

GitHub
Email
Portfolio

~ Let's build something awesome.