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.

Sign up for GitHub

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

Jump to bottom

Update README and AboutUs #328

Merged
merged 3 commits into from
Apr 10, 2023
Merged

Update README and AboutUs #328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f96835
Merge branch 'master' into update-v1.4-final
jianminglok Apr 10, 2023
f4c27f7
Update README and AboutUs
jianminglok Apr 10, 2023
48322cf
Update index.md file
jianminglok Apr 10, 2023
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
22 changes: 16 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,23 @@
# InternEase

InternEase is a **powerful and innovative desktop app designed to streamline the internship application process primarily for Computer Science undergraduates**. With its optimized **combination of a Command Line Interface (CLI) and Graphical User Interface (GUI)**, InternEase offers users the best of both worlds - the speed and efficiency of a CLI for those who can type quickly, and the user-friendly experience of a GUI for those who prefer a visual interface. Whether you’re a seasoned CLI user or a first-time applicant new to work environment, InternEase makes it easy to keep track of your progress, deadlines, and follow-up actions, so you can focus on landing your dream internship.

[![CI Status](https://github.com/AY2223S2-CS2103T-W15-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2223S2-CS2103T-W15-4/tp/actions)
[![codecov](https://codecov.io/gh/AY2223S2-CS2103T-W15-4/tp/branch/master/graph/badge.svg?token=MVV9ABQAS8)](https://codecov.io/gh/AY2223S2-CS2103T-W15-4/tp)

![Ui](docs/images/Ui.png)

* This is **a software engineering project done by Team W15-4 from CS2103T(AY2223S2)**.<br>
The aim of this project is to:
## About the project

* This is **a software engineering project done by Team W15-4 from CS2103T (AY2223S2)**.<br>
* The aim of this project is to:
* help Computer Science students to keep track of their internship applications
* provide a flexible internship application management interface which includes CLI and GUI
* The project is based on an ongoing software project for a desktop application (called _AddressBook-Level3_) used for managing contact details by [SE-EDU initiative](https://se-education.org/addressbook-level3/).
* 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**.
* provide a flexible and efficient internship application management interface via **both CLI and GUI**
* It is named `InternEase` because it eases the internship application management process via both well-implemented CLI and GUI to help users focus on their internship preparations.
* For the detailed documentation of this project, see the **[InternEase Product Website](https://ay2223s2-cs2103t-w15-4.github.io/tp/)**.

## Getting started
* View our [quick start guide](https://ay2223s2-cs2103t-w15-4.github.io/tp/UserGuide.html#quick-start) now to get started on an easier internship journey immediately.

## Acknowledgements
* The project is based on an ongoing software project for a desktop application (called _AddressBook-Level3_) used for managing contact details by [SE-EDU initiative](https://se-education.org/addressbook-level3/).
6 changes: 5 additions & 1 deletion docs/AboutUs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,8 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
[[portfolio](team/jianminglok.md)]

* Role: Developer
* Responsibilities: Add contact and edit status feature
* Responsibilities:
* Contact management features: `add_contact`, `edit_contact`, `delete_contact`
* Document management features: `add_docs`, `edit_docs`, `delete_docs`
* Edit internship application status feature: `edit_status`
* Archiving features: `archive`, `unarchive`, `list_archived`
2 changes: 1 addition & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: InternEase
**InternEase is a desktop application for managing your internship applications.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).

* If you are interested in using InternEase, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
* If you are interested about developing AddressBook, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.
* If you are interested about developing InternEase, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.


**Acknowledgements**
Expand Down