Skip to content

Commit 2e8ff29

Browse files
authored
Merge pull request CSC207-UofT#87 from 1239uth/main
Add nicer README
2 parents 8ae087d + 079030d commit 2e8ff29

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

README.md

+21-12
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,30 @@
1-
## Fitness Tracker with Social Media
1+
# FitApp - Fitness Tracking Android App
22

3-
FitApp is an android app that will serve as a fitness tracker with a social media
3+
FitApp is an Android App that will serve as a fitness tracker with a social media
44
component for fitness enthusiasts who want to monitor and share their fitness experience.
55

6+
_Run in Android Studio for best experience_
67

7-
### NOTE when building (Only if using IntelliJ to run app)
8+
## Core Features
89

9-
Intellij may not automatically generate the `local.properties` file, which is required to run the program.
10+
- Add a routine with workouts containing exercises
11+
- Start a workout and keep track of progress
12+
- Document previous workouts in a workout log
1013

11-
After cloning the repository, create a file called `local.properties` and put it right under
12-
the main module. Inside it, only one line is required, referencing your local location to the Android sdk.
14+
<br></br>
15+
Refer to the [Design Document](phase2/design_document.pdf) for more details
1316

14-
##### For Mac Users:
15-
copy `sdk.dir=/Users/<YOUR_MAC_USERNAME_HERE>/Library/Android/sdk`
17+
## Screenshots
1618

17-
##### For Windows Users:
18-
copy `sdk.dir=C\:\\Users\\<YOUR_WINDOWS_USERNAME_HERE>\\AppData\\Local\\Android\\Sdk`
19+
<img alt="Home Page" src="FitApp-screenshots/HomePage.png" width="250"/> <img alt="Login Page" src="FitApp-screenshots/Login.png" width="250"/>
1920

20-
Here is an image demonstrating what the file would look like for a **Windows User**
21-
![image](https://user-images.githubusercontent.com/50709151/141846711-d53eaa30-ef1b-4101-8a46-a0ae5dd7d347.png)
21+
<img alt="Signup With Error" src="FitApp-screenshots/SignupError.png" width="250"/> <img alt="Weight Info Page" src="FitApp-screenshots/WeightInfo.png" width="250"/>
22+
23+
<img alt="Dashboard Page" src="FitApp-screenshots/Dashboard.png" width="250"/> <img alt="Edit Profile Page" src="FitApp-screenshots/EditProfileInfo.png" width="250"/> <img alt="Edit Weight in Profile Page" src="FitApp-screenshots/EditWeight.png" width="250"/>
24+
25+
<img alt="Routine List Page" src="FitApp-screenshots/RoutineList.png" width="250"/> <img alt="Add Routine Page" src="FitApp-screenshots/AddRoutine.png" width="250"/>
26+
27+
<img alt="Add Workout Page" src="FitApp-screenshots/AddWorkout.png" width="250"/> <img alt="Add Exercise Page" src="FitApp-screenshots/AddExercise.png" width="250"/>
28+
29+
<img alt="View Workout Page" src="FitApp-screenshots/ViewWorkout.png" width="250"/> <img alt="Workout Start" src="FitApp-screenshots/WorkoutStart.png" width="250"/> <img alt="Start Workout Page" src="FitApp-screenshots/StartWorkout.gif" width="250"/>
30+
<img alt="Workout Complete Page" src="FitApp-screenshots/WorkoutComplete.png" width="250"/> <img alt="Workout Logs Page" src="FitApp-screenshots/WorkoutLogs.png" width="250"/>

0 commit comments

Comments
 (0)