https://github.com/mleftwich/employeecms

Employee tracker CLI
https://github.com/mleftwich/employeecms

back-end command-line-interface content-management-system javascript

Last synced: 7 days ago
JSON representation

Employee tracker CLI

• Host: GitHub
• URL: https://github.com/mleftwich/employeecms
• Owner: mleftwich
• Created: 2022-08-01T08:17:32.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-01T05:10:49.000Z (about 2 years ago)
• Last Synced: 2024-11-06T03:48:25.466Z (about 2 months ago)
• Topics: back-end, command-line-interface, content-management-system, javascript
• Language: JavaScript
• Homepage:
• Size: 119 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

  ![MIT](https://img.shields.io/static/v1?label=License&message=MIT&color=green)

  # Employee CMS

  

  ## Table of Contents

  * [Description](#description)

  * [Technologies](#technologies)

  * [Installation](#installation)

  * [Usage](#usage)

  * [Contributing](#contributing)

  * [Guidelines](#guidelines)

  * [Tests](#tests)

  * [License](#license)

  * [Questions](#questions)

---

  ## Description

  This app is a content management system designed to interface with an employee database from the command line. The user can view department, role, and employee records and edit them accordingly, with the ability to add entries, update roles and view the overall budget of the database. It was built using node.js utilizing the inquirer and mysql2 node packages and can be used entirely from any CLI like gitbash or powershell.

  You can view a video demonstration of the app in use [here](https://drive.google.com/file/d/1RPCd4coSRzBDYQkhY5-suuFZGRCekF9r/view).

  ![screenshot](./assets/imgs/screenshot.png)

  ## Technologies

  * JavaScript

  * node.js

  * MySQL

  ## Installation

   Clone the repository, npm install and npm run start

  ## Usage

   npm run start / node app.js from the command line

  ## Contributing

   If you'd like to contribute, reach out through the email below

  ## Guidelines

   Must have an existing database named employees_db, schema is included

  ## Tests

   Tests run in development

  ## License

   Licensed under [MIT](https://opensource.org/licenses/MIT) 

   ---

  ## Questions

   For any questions you can find me at [GitHub](https://github.com/mleftwich) or email me at [[email protected]](mailto:[email protected])