Skip to content

Commit

Permalink
Merge pull request #220 from ICubE-/master
Browse files Browse the repository at this point in the history 
Modify codes and UG
  • Loading branch information
@ICubE-
ICubE- authored Nov 6, 2023
2 parents 42da67b + c61aecd commit 59cbea2
Show file tree
Hide file tree
Showing 34 changed files with 493 additions and 407 deletions.
9 changes: 5 additions & 4 deletions CONTRIBUTORS.md
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# Contributors

Display | Name | Github Profile | Homepage
---|:---:|:---:|:---:
![](https://avatars0.githubusercontent.com/u/22460123?s=100) | Jeffry Lum | [Github](https://github.com/j-lum/) | [Homepage](https://se.kasugano.moe)
![](https://avatars0.githubusercontent.com/u/1673303?s=100) | Damith C. Rajapakse | [Github](https://github.com/damithc/) | [Homepage](https://www.comp.nus.edu.sg/~damithch/)
| Display | Name | Github Profile | Homepage |
|--------------------------------------------------------------|:-------------------:|:-------------------------------------:|:--------------------------------------------------:|
| ![](https://avatars0.githubusercontent.com/u/22460123?s=100) | Jeffry Lum | [Github](https://github.com/j-lum/) | [Homepage](https://se.kasugano.moe) |
| ![](https://avatars0.githubusercontent.com/u/1673303?s=100) | Damith C. Rajapakse | [Github](https://github.com/damithc/) | [Homepage](https://www.comp.nus.edu.sg/~damithch/) |

# I would like to join this list. How can I help the project

For more information, please refer to our [contributor's guide](https://oss-generic.github.io/process/).
14 changes: 7 additions & 7 deletions docs/AboutUs.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# About us

Display | Name | Github Profile | Portfolio
--------|:------------:|:----------------------------------------:|:---------:
![](https://via.placeholder.com/100.png?text=Photo) | Faris Sirraj | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
![](https://via.placeholder.com/100.png?text=Photo) | Yeon Jeho | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
<img src="images/joshua.jpg" width = 25% height = 25%> | Joshua Leong | [Github](https://github.com/J0shuaLeong) | [Portfolio](docs/team/joshua.md)
![](https://via.placeholder.com/100.png?text=Photo) | Ng Lixuan Nixon | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
![](https://via.placeholder.com/100.png?text=Photo) | Mark Lin | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
| Display | Name | Github Profile | Portfolio |
|--------------------------------------------------------|:---------------:|:----------------------------------------:|:---------------------------------:|
| ![](https://via.placeholder.com/100.png?text=Photo) | Faris Sirraj | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md) |
| ![](https://via.placeholder.com/100.png?text=Photo) | Yeon Jeho | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md) |
| <img src="images/joshua.jpg" width = 25% height = 25%> | Joshua Leong | [Github](https://github.com/J0shuaLeong) | [Portfolio](docs/team/joshua.md) |
| ![](https://via.placeholder.com/100.png?text=Photo) | Ng Lixuan Nixon | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md) |
| ![](https://via.placeholder.com/100.png?text=Photo) | Mark Lin | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md) |

40 changes: 18 additions & 22 deletions docs/DeveloperGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,10 @@ Main structure of the code and the parse feature is adapted from [here](https://
The ***Architecture Diagram*** above shows the high-level overview and design of the FitTrack app.
Given below is a quick overview of each component.

<div markdown="span" class="alert alert-primary">

:bulb: **Tip:** The '.puml' files used to create the diagrams in this document can be found in [diagrams](./diagrams)
folder. Refer to the [_PlantUML Tutorial_ at se-edu/guides](https://se-education.org/guides/tutorials/plantUml.html)
to learn how to create and edit diagrams.

</div>

The **`Main`** class is called [`FitTrack`](../src/main/java/fittrack/FitTrack.java)

The App consists of eight components.
Expand Down Expand Up @@ -86,24 +82,24 @@ BMI, ideal weight for their height and so on.

## User Stories

|Version| As a ... | I want to ... | So that I can ... |
|--------|----------|-------------------------------------------------------------|---------------------------------------------------------------|
|v1.0|new user| know how to use the product | use the product |
|v1.0|new user| add my height and weight | keep track of my height and weight |
|v1.0|new user| add my calorie intake for a meal | record my calorie intake |
|v1.0|new user| add my daily workout | track my calories burnt |
|v1.0|new user| set my daily calorie surplus limit | know whether my calorie surplus has exceeded the limit or not |
|v1.0|new user| delete my daily workout | track my calorie usage |
|v1.0|new user| delete my calorie intake for a meal | track my calorie intake |
|v1.0|new user| edit my height and weight information | apply my changed height and weight |
|v1.0|new user| view my calorie intake for a meal | know my calorie intake |
|v1.0|new user| view my daily workout | know my previous daily workouts |
|v1.0|new user| view my height, weight, and daily calorie surplus limit | know my height, weight and calorie surplus limit |
|v2.0|user| find a to-do item by name | locate a to-do without having to go through the entire list |
|v2.0|user| Calculate my ideal weight for my height | maintain my weight in the healthy range |
|v2.0|user| see the total calories I have consumed on a particular date | track my daily calories intake |
|v2.0|user| see the total calories I have burnt on a particular date | track my daily calories burnt |
|v2.0|user| find a meal or workout | quickly search my past meals or workouts |
| Version | As a ... | I want to ... | So that I can ... |
|---------|----------|-------------------------------------------------------------|---------------------------------------------------------------|
| v1.0 | new user | know how to use the product | use the product |
| v1.0 | new user | add my height and weight | keep track of my height and weight |
| v1.0 | new user | add my calorie intake for a meal | record my calorie intake |
| v1.0 | new user | add my daily workout | track my calories burnt |
| v1.0 | new user | set my daily calorie surplus limit | know whether my calorie surplus has exceeded the limit or not |
| v1.0 | new user | delete my daily workout | track my calorie usage |
| v1.0 | new user | delete my calorie intake for a meal | track my calorie intake |
| v1.0 | new user | edit my height and weight information | apply my changed height and weight |
| v1.0 | new user | view my calorie intake for a meal | know my calorie intake |
| v1.0 | new user | view my daily workout | know my previous daily workouts |
| v1.0 | new user | view my height, weight, and daily calorie surplus limit | know my height, weight and calorie surplus limit |
| v2.0 | user | find a to-do item by name | locate a to-do without having to go through the entire list |
| v2.0 | user | Calculate my ideal weight for my height | maintain my weight in the healthy range |
| v2.0 | user | see the total calories I have consumed on a particular date | track my daily calories intake |
| v2.0 | user | see the total calories I have burnt on a particular date | track my daily calories burnt |
| v2.0 | user | find a meal or workout | quickly search my past meals or workouts |



Expand Down
Loading

0 comments on commit 59cbea2

Please sign in to comment.