Skip to content

Commit

Permalink
Merge branch 'master' into targetuserprofile-valuepropostion
Browse files Browse the repository at this point in the history
  • Loading branch information
AaronCQL committed Mar 2, 2020
2 parents dcdd588 + 7eb4ef8 commit 3dfcb29
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 19 deletions.
10 changes: 6 additions & 4 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Address Book (Level 3)
= FitBiz
ifdef::env-github,env-browser[:relfileprefix: docs/]

https://travis-ci.com/AY1920S2-CS2103T-F11-2/main[image:https://travis-ci.com/AY1920S2-CS2103T-F11-2/main.svg?branch=master[Build Status]]
Expand All @@ -12,9 +12,11 @@ ifndef::env-github[]
image::images/Ui.png[width="600"]
endif::[]

* This is a desktop Address Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
* It is a Java sample application intended for students learning Software Engineering while using Java as the main programming language.
* It is *written in OOP fashion*. It provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC) than what students usually write in beginner-level SE modules.
* Extensive: Tracks finances, calorie intake, workouts.
* Detailed Data Representation: Displays graphs and charts for clients.
* Save Time: Show summary at an instance.
* Tailored for single-user.
* This is a desktop application for a gym manager to manage his clients. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
== Site Map

Expand Down
4 changes: 2 additions & 2 deletions docs/ContactUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
:site-section: ContactUs
:stylesDir: stylesheets

* *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level3/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
* *Bug reports, Suggestions* : Post in our https://github.com/AY1920S2-CS2103T-F11-2/main/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
* *Contributing* : We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here]
* *Email us* : You can also reach us at `damith [at] comp.nus.edu.sg`
* *Email us* : You can also reach us at `e0310119[at]u.nus.edu.sg`
67 changes: 54 additions & 13 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ ifdef::env-github[]
:note-caption: :information_source:
:warning-caption: :warning:
endif::[]
:repoURL: https://github.com/se-edu/addressbook-level3/tree/master
:repoURL: https://github.com/AY1920S2-CS2103T-F11-2/main

By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`
By: `AY1920S2-CS2103T-F11-2`   Since: `Jun 2016`      Licence: `MIT`

== Setting up

Expand Down Expand Up @@ -294,20 +294,41 @@ Refer to the guide <<DevOps#, here>>.

Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (unlikely to have) - `*`

[width="59%",cols="22%,<23%,<25%,<30%",options="header",]
[width="59%",cols="22%,<30%,<35%,<50%",options="header",]
|=======================================================================
|Priority |As a ... |I want to ... |So that I can...
|`* * *` |new user |see usage instructions |refer to instructions when I forget how to use the App
|`* * *` |coach for fitness competitors |I can record the personal bests of my clients|monitor their progress.
|`* * *` |coach for fitness competitors |record the food intake of my clients|know if they are following my diet plan for them
|`* * *` |coach for fitness competitors |record the exercise type and intensity my clients have done for the day| know if they are on track for their competitions.
|`* * *` |coach for fitness competitors |record the date and time of my clients’ training sessions |
|`* * *` |coach with many fitness competitors | view my overall schedule for the day/week |
|`* * *`| coach that communicates with my clients| display visualisations(graphs/charts) | convey the client's training progress better
|`* * *`| coach with many clients | calculate the caloric deficit or surplus for the day | plan the following dietary needs of my clients.
|`* * *`| coach with many clients | reminded of my daily schedule at the start of the day | will not forget my appointments.
|`* * *`| coach with many clients | add new profiles to the app to keep track of new clients|
|`* * *`| coach | manage the total training hours/payment day of the clients | charge them accordingly
|`* * *`| coach| list all my clients | view a summary of all my clients
|`* * *`| coach | delete my client|
|`* * *`| coach |look for user help | get help on how to use the features.
|`* * *`| coach | find my client by typing their name | find my client’s information easily.
|`* *`| coach for fitness competitors | view incoming competitions of my clients | be reminded to focus on them more
|`* *`| forgetful coach with many clients | look at my records on clients | know what exercises they are weak in or require more assistance
|`* *`| coach with a tight schedule | display my open slots | plan for training more effectively.
|`* *`| coach with clients all over SG | find the nearest gym based on where my client stays. |
|`* *`| coach with many clients | set personalised goals for my clients | I can plan a workout routine that is achievable
|`* *`| coach with many clients| pre-set standard meal profiles my clients take every day | daily caloric intake is automated
|`* *`| coach with a tight schedule |opt to switch the app to a minimised view to present to me just the important data of the app|
|`* *`| coach with many different clients| easily export the data of a client (to a CSV file) | client can also backup and store that data for themselves.
|`* *`| coach |track my clients’ macros | I can tell if my client is eating right with the right proportions.
|`* *`| coach | track my total earnings from all my clients.|
|`* *`| coach | track who is going for a competition by using the competition tag. |
|`*` | coach that likes to vary my clients’ training| choose from a list of different exercises with the same purposes |
|`*` | coach who wants to visually track the progress of my clients| store photos to monitor the changes in my client’s physique. |
|`*` | coach| check if the gym I am going to is closed|
|`*` | coach| use the timer in the app| I can seamlessly execute the time interval of the workout planned.
|`*` | coach| book the facilities required by the workout.|
|`*` | coach |see upcoming competitions or meet | I can plan for my clients to attend them.

|`* * *` |user |add a new person |

|`* * *` |user |delete a person |remove entries that I no longer need

|`* * *` |user |find a person by name |locate details of persons without having to go through the entire list

|`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident

|`*` |user with many persons in the address book |sort persons by name |locate a person easily
|=======================================================================

_{More to be added}_
Expand Down Expand Up @@ -351,6 +372,13 @@ _{More to be added}_
. Should work on any <<mainstream-os,mainstream OS>> as long as it has Java `11` or above installed.
. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.
. Should work without the need for Internet in the program.
. Should work reliably.
. Should be able to store data in a human-readable format.
. Should be for a single user.
. Should not use DBMS to store data.
. Should not exceed 100Mb in file size.


_{More to be added}_

Expand All @@ -363,6 +391,19 @@ Windows, Linux, Unix, OS-X
[[private-contact-detail]] Private contact detail::
A contact detail that is not meant to be shared with others

[[exercise-template]] Exericse Template::
An outline for an exercise.

[[exercise]] Exercise::
A fixed set of repetitions according to an exercise template.

[[training-routine]] Training Routine::
An outline for a set of exercises.

[[training]] Training::
A fixed set of exercises according to a training routine.


[appendix]
== Product Survey

Expand Down

0 comments on commit 3dfcb29

Please sign in to comment.