Skip to content

AY2223S2-CS2103T-T14-3/tp

 
 

Repository files navigation

CI Status codecov

Logo

About InternBuddy

InternBuddy is a desktop application for Computing undergraduates to manage their internship applications. It is optimized for typing where it allows you to complete internship management tasks much more efficiently via the keyboard as compared to using traditional Graphical User Interface (GUI) applications. If you are a fast typist who is seeking a one-stop platform to systematically organise your internship applications, then InternBuddy is the perfect buddy to accompany you during your internship hunt.

InternBuddy runs using Java 11, and is available on the Windows, macOS and Linux operating systems.

Core Features

  1. List all internships
  2. Add an internship
  3. Edit an internship
  4. View an internship
  5. Copy an internship to clipboard
  6. Find internships
  7. Get upcoming events and deadlines
  8. Delete internships by indices
  9. Delete internships by fields
  10. Clear all internships
  11. Get help
  12. Exit
  13. Navigating through past commands

In InternBuddy, internship data is auto-saved whenever changes are made.

Getting Started

  1. Ensure you have Java 11 or above installed in your computer. Otherwise, you can download it here.

  2. Download the latest release of InternBuddy here.

  3. Copy the file internbuddy.jar to the folder that you want to use as the home folder for InternBuddy.

  4. Double-click on the file internbuddy.jar to launch InternBuddy. A GUI similar to the diagram below should appear in a few seconds. Note how the app contains some sample data.

    Ui

  5. You can interact with InternBuddy by typing into the box with the text Enter command here..., then pressing Enter to execute your command. For example, typing help and pressing Enter will open the help window.

  6. Enjoy tracking your internships with InternBuddy!

Additional Information

  • If you are a user who is interested in learning more about what InternBuddy offers, do visit the InternBuddy User Guide.

  • Alternatively, if you are a developer who is curious about the implementation of InternBuddy, check out the InternBuddy Developer Guide.

Acknowledgements

  • InternBuddy is written in Java 11.
  • It is adapted from the AddressBook Level 3 project created by the SE-EDU initiative.
  • Libraries and frameworks used: JavaFX, Jackson, JUnit5 and TestFX.
  • GUI testing is implemented with references from AddressBook Level 4 and Please Hire Us. We utilised code from these projects to set up GUI testing and added our own test cases to test the UI components that we created.
  • The feature of Navigating Through Past Commands is primarily adapted from HackNet, but we added code modifications and test cases.
  • The sections on explaining the formatting standards and GUI interface in the User and Developer Guides are inspired by Please Hire Us.