Skip to content

Commit

Permalink
Merge branch 'AY2324S1-CS2103T-T17-3:master' into add-saltedfishxx-info
Browse files Browse the repository at this point in the history
  • Loading branch information
saltedfishxx authored Oct 4, 2023
2 parents 8ae2693 + 71f8294 commit c8b8239
Show file tree
Hide file tree
Showing 10 changed files with 184 additions and 150 deletions.
47 changes: 37 additions & 10 deletions README.md
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).
44 changes: 22 additions & 22 deletions docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,25 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`

## Project team

### John Doe
### Joshua Weng Hao

<img src="images/johndoe.png" width="200px">
<img src="images/jweng88.png" width="200px">

[[homepage](http://www.comp.nus.edu.sg/~damithch)]
[[github](https://github.com/johndoe)]
[[portfolio](team/johndoe.md)]
[[github](https://github.com/jweng88)]
[[portfolio](team/jweng88.md)]

* Role: Project Advisor
* Role: Developer
* Responsibilities: Tutor deletion, Tutor viewing

### Jane Doe
### Muhammad Fikri

<img src="images/johndoe.png" width="200px">
<img src="images/mfjkri.png" width="200px">

[[github](http://github.com/johndoe)]
[[portfolio](team/johndoe.md)]
[[github](http://github.com/mfjkri)]
[[portfolio](team/mfjkri.md)]

* Role: Team Lead
* Responsibilities: UI
* Role: Developer
* Responsibilities: Tutor search

### Johnny Doe

Expand All @@ -38,22 +38,22 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
* Role: Developer
* Responsibilities: Data

### Jean Doe
### Teo Rui Shan

<img src="images/johndoe.png" width="200px">
<img src="images/ruishanteo.png" width="200px">

[[github](http://github.com/johndoe)]
[[portfolio](team/johndoe.md)]
[[github](http://github.com/ruishanteo)]
[[portfolio](team/ruishanteo.md)]

* Role: Developer
* Responsibilities: Dev Ops + Threading
* Responsibilities: Add Tutors functionalities

### James Doe
### Yeo Di Sheng

<img src="images/johndoe.png" width="200px">
<img src="images/dishenggg.png" width="200px">

[[github](http://github.com/johndoe)]
[[portfolio](team/johndoe.md)]
[[github](https://github.com/dishenggg)]
[[portfolio](team/dishenggg.md)]

* Role: Developer
* Responsibilities: UI
* Responsibilities: Add schedule
Loading

0 comments on commit c8b8239

Please sign in to comment.