moedaaboul/employee-tracker

A command-line application to manage a company's employee database.

employee-tracker

Description

A Node.js command-line application that allows non-developers to easily view and interact with information stored in databases. This interface is an example of a content management systems (CMS).

The task was to develop this command-line application from scratch to manage a company's employee database, using Node.js, Inquirer, and MySQL.

Table of Contents

• Description
• Installation
• Usage
• Directory Structure
• Technologies Used
• Schema
• Setup
• Demo
• Acknowledgements
• Questions
• License

Installation

​Install dependencies using:

npm install

Usage

Login to mysql using the terminal using and the follow with your password:

mysql -u root -p

The db schema and seeds will be added using the following:

source .db/schema.sql

source .db/seeds.sql

The application will then be invoked by using the following command:

npm start

Directory Structure

.
├── assets/
├── db/
├── src/
│ ├── helpers/
│ └── questions/
├── .gitignore
├── index.js
├── package.json
└── README.md

Technologies Used

• MySQL
• Node.js
• mysql2
• inquirer
• dotenv
• cli-color
• console.table

Schema

Setup

• Nodejs must be installed
• MySQL must be installed
• MySQL Workbench (a MySQL GUI - highly recommended)
• Text editor (VS Code recommended)

Demo

Acknowledgements

• https://www.npmjs.com/package/dotenv
• https://www.npmjs.com/package/mysql2
• https://www.npmjs.com/package/inquirer
• https://www.npmjs.com/package/cli-color
• https://www.npmjs.com/package/console.table

Questions

Created by: @moedaaboul

Feel free to contact me via [email protected]!

License

This work is licensed under MIT.