Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README and About Us pic #33

Merged
merged 2 commits into from
Mar 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 36 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,39 @@
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103T-T14-1/tp/actions)
[![codecov](https://codecov.io/gh/AY2324S2-CS2103T-T09-4/tp/graph/badge.svg?token=WAIOG42WJK)](https://codecov.io/gh/AY2324S2-CS2103T-T14-1/tp)

# EffiTrack

![Ui](docs/images/Ui.png)
> Boost productivity, streamline success! Welcome to EffiTrack – where efficiency meets innovation. Revolutionize your workday with seamless employee performance tracking.

## Value Proposition
HR departments often struggle to accurately measure employee efficiency, leading to reduced productivity. Traditional methods of tracking employee performance, such as manual documentation or outdated systems, are time-consuming and prone to errors. EffiTrack solves these challenges by providing a centralized platform to effortlessly monitor employee efficiency.

## Features
- [ ] Add employee information
- [ ] List all employees information
- [ ] Edit an existing employee information
- [ ] Find employees whose names contain any of the given keywords
- [ ] Delete a specific employee
- [ ] Clear all entries
- [ ] Assign task to an employee
- [ ] Mark an assigned task as done
- [ ] Edit deadline of assigned task
- [ ] Change person in charge of the task
- [ ] Sort employee based on efficiency
- [ ] Display upcoming deadlines
- [ ] Display fire list
- [ ] Generate efficiency report

## Get Started
1. Download EffiTrack here.
2. Navigate to your Downloads folder using the terminal.
3. Type `java -jar EffiTrack.jar` in your terminal.
4. Press enter.
5. Give it a try now!

## Documentation
For the detailed documentation of this project, see the **[EffiTrack Product Website](https://ay2324s2-cs2103t-t14-1.github.io/tp/)**.

* This is **a sample project for Software Engineering (SE) students**.<br>
Example usages:
* as a starting point of a course project (as opposed to writing everything from scratch)
* as a case study
* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
* It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
* It comes with a **reasonable level of user and developer documentation**.
* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
* For the detailed documentation of this project, see the **[Address Book Product Website](https://ay2324s2-cs2103t-t14-1.github.io/tp/)**.
* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
## Acknowledgement
This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org)
Binary file modified docs/images/yiwern5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading