Skip to content

Latest commit

 

History

History
193 lines (142 loc) · 7.58 KB

README.md

File metadata and controls

193 lines (142 loc) · 7.58 KB
Raw

Employee-Management-System

Description

This project is an employee management system, it can view all employees, roles, and departments inside the database. It can also add additional employees, roles, and departments. My motivation for creating this project was to help users manager their employees, roles, and department within their company in a simple interface. The problem this helps with is companies can have an easier time keeping track of their employees, which department they're in, what is their role is and who their managers is.

Link to the Project

Table of Contents

Installation

  • To clone the repository
    • Make sure you have right access to pull in the reposotiory either by applying 'ssh' keys or by providing a username and password'
    • Make sure your path is proper
    • Copy the git command to where you want to clone the repository
    git clone [email protected]:ByteSizeError/Employee-Management-System.git
    • You will see a Employee-Management-System folder.
  • An alternate document to clone a repo can also be found at github

Project Demo

Start Program

Start

View All Employees

View All Employees

View All Roles

View All Roles

View All Departments

View All Departments

Add Department

Add Department

Add Role

Add Role Add Role 2 Add Role 3

Add Employee

Add Employee Add Employee 2 Add Employee 3 Add Employee 4

View Updated Employees After Adding Employee

View Updated Employees

Update Employee Role

Update Role Update Role 2

View Updated Employees After Updating Role

View Updated Employees 2

View Updated Roles After Adding Role

View Updated Roles

View Updated Departments After Adding Department

View Updated Departments

Usage

  • Users can view all employees in the database.

  • Users can view all roles in the database.

  • Users can view all departments in the database.

  • Users can add new employees into the database.

  • Users can add new roles into the database.

  • Users can add new departments into the database.

  • Users can update any employees role within the database.

License

License: MIT

https://www.mit.edu/~amini/LICENSE.md


      Copyright (c) 2021 Jimmy Zheng
      
      Permission is hereby granted, free of charge, to any person obtaining a copy
      of this software and associated documentation files (the "Software"), to deal
      in the Software without restriction, including without limitation the rights
      to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
      copies of the Software, and to permit persons to whom the Software is
      furnished to do so, subject to the following conditions:
      
      The above copyright notice and this permission notice shall be included in all
      copies or substantial portions of the Software.
      
      THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
      IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
      FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
      AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
      LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
      OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
      SOFTWARE.

Contributing

Contributor Covenant

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

Examples of behavior that contributes to a positive environment for our community include:

  • Demonstrating empathy and kindness toward other people.
  • Being respectful of differing opinions, viewpoints, and experiences.
  • Giving and gracefully accepting constructive feedback.
  • Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience.
  • Focusing on what is best not just for us as individuals, but for the overall community.

Examples of unacceptable behavior include:

  • The use of sexualized language or imagery, and sexual attention or advances of any kind
  • Trolling, insulting or derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or email address, without their explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.

For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

Tests

Testing can be performed in the command line after installation of the project on the machine. To test the proeject go into the command line and type in

npm i

to install all the required modules. To run and test the program type in

npm start

If modules are missing type in

npm i

and follow the instructions for how to fix package issues.

After all required modules are installed should be able to run the program. It will prompt you for project information. Here is where you can test the project.

Questions

For questions you can reach me at https://github.com/ByteSizeError.

You can also reach me at [email protected] for additional questions.