Your EmployeeDB is a content management system (CMS) interface that allows non-developers to easily view and interact with their staff's information. This is a command-line application that uses Node.js, Inquirer, and a MySQL database. With Your EmployeeDB, business owners can view and manage their company's departments, roles and employees. After invoking the application, User is presented with 7 options: View All Departments, View All Roles, View All Employees, Add a Department, Add a Role, Add an Employee, and Update an Employee Role.
- Description
- Table of Contents
- Usage
- Installation
- License
- Technologies Employed
- Future Development
- Contributing
- Tests
- Questions
AS A business owner
I WANT to be able to view and manage the departments, roles, and employees in my company
SO THAT I can organize and plan my businessGIVEN 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 databaseTo run Your EmployeeDB 👩🏽💼👩🏽💻 locally:
- Pull down and/or branch this repository
- Run
npm ito install all dependencies - Invoke app with
node index.js
ornodemon index.jsfor nodemon
This is a command line application and has not been deployed. The following animation shows its use as directed:
Employee.Tracker.Demo.mp4
This project is licensed under the MIT license.
A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.
For more information visit MIT Licensing.
- SQL
- Node
- Dotenv
- Inquirer
- JavaScript
- MySQL Server
We would like to continue to add the following functionality to our application:
- Inquirer "Back" Interaction
- Update Employee Managers
- View Employees by Manager
- View Employees by Department
- Delete Department, Role and Employee
- View Total Utilized Budget of Department
We'd love for you to contribute! In order to do so, fork this repository. Your pull request will need approval in order to merge to main.
Take a look at our Future Development section to see what we are looking to expand on (implemented features are denoted with a ✓). Feel free to implement your own ideas and merge request!
No tests were run to complete this CMS.
Find Insha Sayani on GitHub
Or visit the CMS's repository: Your EmployeeDB 👩🏽💼👩🏽💻
© 2022 Your EmployeeDB 👩🏽💼👩🏽💻: Content Management System by ISayani Creative Services, Confidential and Proprietary. All Rights Reserved.