forked from nus-cs2103-AY2324S1/tp
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'AY2324S1-CS2103T-T17-3:master' into add-saltedfishxx-info
- Loading branch information
Showing
10 changed files
with
184 additions
and
150 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,42 @@ | ||
# Tutor Connect | ||
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-T17-3/tp/actions) | ||
[![codecov](https://codecov.io/gh/AY2324S1-CS2103T-T17-3/tp/graph/badge.svg?token=CY67NSXKQZ)](https://codecov.io/gh/AY2324S1-CS2103T-T17-3/tp) | ||
|
||
Tutor Connect is an **address book made for tuition centre managers** to easily track, schedule, and notify tutors of their upcoming schedule, optimised for users who prefer a CLI. | ||
|
||
![Ui](docs/images/Ui.png) | ||
|
||
* 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://se-education.org/addressbook-level3)**. | ||
* 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. | ||
## Features | ||
- **Store** and **edit** information about your tutors | ||
- **Create** and **plan** your tutor availability and schedule | ||
- **View** upcoming schedules | ||
|
||
If you are interested in **using** Tutor Connect, head over to the [Quick Start](https://ay2324s1-cs2103t-t17-3.github.io/tp/UserGuide.html#quick-start) section of the User Guide. | ||
|
||
If you are interested in **developing** Tutor Connect, the [Developer Guide](https://ay2324s1-cs2103t-t17-3.github.io/tp/DeveloperGuide.html) is a good place to start. | ||
## Requirements | ||
Ensure you have **Java 11** installed on your computer. | ||
To verify, perform the following steps: | ||
|
||
1. Open a terminal | ||
- [MacOS](https://support.apple.com/en-sg/guide/terminal/apd5265185d-f365-44cb-8b09-71a064a42125/mac#:~:text=Terminal%20for%20me-,Open%20Terminal,%2C%20then%20double%2Dclick%20Terminal) | ||
- [Windows](https://www.howtogeek.com/235101/10-ways-to-open-the-command-prompt-in-windows-10/#:~:text=anywhere%20you%20like.-,Open%20Command%20Prompt%20from%20the%20Run%20Box,open%20an%20administrator%20Command%20Prompt) | ||
2. Type `java -version` and press Enter. | ||
3. If it says a version other than 11 or `command not found`, please install Java 11 by following this [guide](https://www.java.com/en/download/help/download_options.html). | ||
|
||
## Installation Guide | ||
1. **Download** the latest jar file (tutorconnect.jar) from our [Github Releases](https://github.com/AY2324S1-CS2103T-T17-3/tp/releases). | ||
|
||
2. Move the jar file into a new folder called “Tutor Connect” | ||
|
||
3. Double click the jar file to launch the application. | ||
|
||
> If you are a **Mac** user, you may encounter a warning that says the jar file cannot be opened because it is from an unidentified developer. | ||
> To continue: | ||
> | ||
> i. **Right click** on the jar file and select `Open With > JavaLauncher (default)`. | ||
> | ||
> ii. Press **Open** when prompted. | ||
## Acknowledgements | ||
This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.