Skip to content

Commit

Permalink
Updated README.md and added logo.
Browse files Browse the repository at this point in the history
  • Loading branch information
ItsRootUser committed Apr 28, 2024
1 parent c25a776 commit f82a7bf
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 65 deletions.
83 changes: 18 additions & 65 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
![Employee Management System Logo](./assets/logo.png)

# Employee Management System

This is a simple command-line based Employee Management System written in Python. It allows you to manage a list of employees, add new employees, remove existing employees, edit employee details, list all employees and view employee details.

## Requierments
## Features
| Feature | Normal | Donator |
| --------------------------| :------: | :-------: |
| Adding Employees |||
| Deleting Employees |||
| Editing Employees |||
| Listing Employees |||
| Showing Employee Profiles |||
| Generating Random Data |||
| Good Feeling |||

## Requirements

- Windows 7 or higher
- Python 3.12 or higher

## Getting Started
Expand All @@ -14,72 +28,11 @@ This is a simple command-line based Employee Management System written in Python

## Login

Upon starting the script, you will be presented with a login screen. Default login is `admin` and password is `admin123`.

## After Login

After successful login, you will be presented with a main menu which has the following options:

- Enter Employee Management System
- About
- Credits
- Licence
- Logout

## Employee Management System

Selecting option 1 will take you to the Employee Management System menu which has the following options:

- Add Employee
- Remove Employee
- Edit Employee
- List Employees
- Show Employee Profile
- Logout

## Add Employee

Selecting option 1 will allow you to add a new employee. You will be asked to enter the following details:

- Employee ID
- Employee First Name
- Employee Last Name
- Employee Age
- Employee Gender
- Employee Role

## Remove Employee

Selecting option 2 will allow you to remove an existing employee. You will be asked to enter the Employee ID of the employee you want to remove.

## Edit Employee

Selecting option 3 will allow you to edit the details of an existing employee. You will be asked to enter the Employee ID of the employee you want to edit. After entering the Employee ID, you will be asked to enter the new details for the employee.

## List Employees

Selecting option 4 will display the details of all employees in the `employees.json` file.

## Show Employee Profile

Selecting option 5 will display the details of the employee with the entered Employee ID.

## Logout
Upon starting the script, you will be presented with a login screen. Default login is `admin` and password is `admin123`. You can change that later.

Selecting option 6 will log you out of the system and take you back to the login screen.

## Note

The `employees.json` file is used to store the details of all employees. The details are stored in JSON format. The script will automatically create the `employees.json` file if it does not exist.

## About

This Employee Management System was created as a simple project to demonstrate the use of Python for command-line based applications.

## Credits

This Employee Management System was created by root.

## Licence

This Employee Management System is released under the GNU GENERAL PUBLIC LICENSE.
This Employee Management System is released under the GNU GENERAL PUBLIC LICENSE.
You can view more in LICENSE file.
Binary file added assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f82a7bf

Please sign in to comment.