Skip to content

A node based CMS for employee management using the Inquirer library

License

Notifications You must be signed in to change notification settings

shamik05/Employee-CMS

Repository files navigation

Employee Tracker

GitHub License

Description

This is a Content Management Systems focused-application for managing a company's employee database. It's built with a node interface and uses the inquirer npm package to communicate to a mysql backend. The results are then displayed using the console.table npm package. It has three major components (tables) in the database - Employees, Roles and Departments. Each management table consists of its own views, adding, removing and updating functions which the user has complete control over. The schema files in the sql folder can be consulted to find a detailed database structure.

Table of Contents

Installation

Download or clone the repo to a working director and extract its contents. Use a Command Line Interface to install necessary dependencies by running the following command:

npm i

To create the database, copy the contents from schema and run it any application capable of managing MySQL database. MySQL Workbench was used for the development process. Sample data has also been provided in the sql in the form of .csv files for populating your database and demo the app.

Configuration

Locate the connection.js file inside the config folder and change the create connection function with your appropriate parameters.

Usage

Type the following in any CLI to run the app.

node index.js

Each module's functions have also been demo-ed below.

Main

Main

Employees

View

View

Add/Delete

Add/Delete

Update

Update

Roles

View

View

Add/Delete

Add/Delete

Update

Update

Departments

View

View

Add/Delete

Add/Delete

Update

Update

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Contributing

Message the owner on github or by email. See CONTRIBUTING.md

Questions

If you have any questions about the repo, open an issue or contact me directly at shamik05@hotmail.com. You can find more of my work at shamik05.

About

A node based CMS for employee management using the Inquirer library

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published