swpp2021-team14

FitVox

Below sections explain how you run the application and tests for each sprint.

Sprint2

After cloning the repository, you should run the following commands to run the application.

cd swpp2021-team14
cd fitvoxfrontend
yarn #Install dependencies
yarn run backend #Run json server
yarn start #Run react app

• For the Sprint2, you can only login with the following email and password.

  • email: [email protected]
  • password: iluvswpp
  • Created new account will be added to json server, but as we didn't implemented the proper authentication yet, signing in using the new account will not be supported.

To test the application, run the following commands on the fitvoxfrontend directory. For the Sprint2, we only support the frontend unittest as we didn't implemened the backend yet, specifically only for the features that we implemented in the Sprint.

yarn test --coverage --watchAll=false

Sprint3

After cloning the repository, you should run the following commands to run the application.

Run frontend server

cd swpp2021-team14
cd fitvoxfrontend
yarn #Install dependencies
yarn start #Run react app

Run backend server

cd swpp2021-team14
cd fitvoxbackend
python manage.py runserver # Run Django Backend Server

• For sprint 3, you can login with default user
  • username: test
  • password: password
• Or you can login with your own account after create one in Create Account page
• You can change personal settings for exercise hardness and default break time in setting page, search exercises through exericse_list page, and add new exercise in add page

To test frontend of the application, run the following commands on the fitvoxfrontend directory. In sprint3 we support frontend features except CreateAccount.js and actionCreators

yarn test --coverage --watchAll=false

To test backend of the application, run the following commands on fitvoxbackend directory. Make sure that your python version is more than 3.7.0

coverage run --source='./Fitvox' manage.py test

Sprint4

After cloning the repository, you should run the following commands to run the application.

Run frontend server

cd swpp2021-team14
cd fitvoxfrontend
yarn install #Install dependencies
yarn start #Run react app

Run backend server

cd swpp2021-team14
cd fitvoxbackend
pip install -r requirements.txt
python manage.py runserver # Run Django Backend Server

Features

• For sprint 4, you can login with default user

  • username: test
  • password: password

• Or you can login with your own account after create one in Create Account page

• You can change personal settings for exercise hardness and default break time in setting page, search exercises through exericse_list page, and add new exercise in add page

• You can use Menu button on the left top of the page to move to the proper page.

• You can check favorite exercises in exercise list page, but this feature has minor errors and will improved in Sprint5.

• After selecting muscle type and exercise type, and by adding some tags, you can see the statistics for the selected exercises.

• After selecting exercise in exercise list page, you may see the detail for the exercise. You may see the statistics for the exercise, and may modify tags or mark the exercise as favorite.

• If you click the appropriate date on the calendar of main page and click the move button, you can see the workout detail for the date.

• You can do following jobs in the workout detail page for the date.

  • You can add the body information of the date if you want.

  • You can add or delete an exercise to the workout using the same query system as in the exercis list page.

  • You can add, modify, or delete the set information for each exercise in the workout.

Testing

To test frontend of the application, run the following commands on the fitvoxfrontend directory. In sprint4 we support tests for frontend features except CreateAccount.js.

# yarn add coveralls
yarn test --coverage --watchAll=false

To test backend of the application, run the following commands on fitvoxbackend directory. Make sure that your python version is more than 3.7.0.

# pip install coveralls
# If error related to db happends, please run 
# python3 manage.py makemigrations
# first.
coverage run --source='./Fitvox' manage.py test

Sprint 5

After cloning the repository, you should run the following commands to run the application.

Run frontend server

cd swpp2021-team14
cd fitvoxfrontend
yarn install #Install dependencies
yarn start #Run react app

Run backend server

You need nvidia gpu to run the fitvoxbackend/Fitvox/voicepartner.py. You must setup appropriate pytorch modules(torch, torchvision, torchaudio) and cuda toolkits base on your machine configuration so that torch.cuda.is_available()will be true. We recommend you to use torch version higher than 1.9.1. Also you need to install libsndfile1 on your local machine to use the python modules installed through pip install -r requirements.txt.

cd swpp2021-team14
cd fitvoxbackend
pip install -r requirements.txt
# sudo apt-get update
sudo apt-get install libsndfile1
python manage.py makemigrations
python manage.py migrate
python manage.py runserver # Run Django Backend Server

Features

• For sprint 5, you can login with default user

  • username: test
  • password: password

• Or you can login with your own account after create one in Create Account page.

• Features newly added at Sprint 5 are as follows.

• By selecting the date on the calendar and click the "GET SUMMARY" button on the main page, you can see the summary of the workout of that day.

• By clicking the statistics button below the menu button on the main page, you can move to the page showing the statistics for specific timeframe. By giving the timeframe and click the show button, you can see the summary of the workouts for the given timeframe.

• User Information Page is added. You can see the current body information and Big-3 weights on the "SUMMARY" tab. You can see the chart for the change of body information and Big-3 weights on the "BODY STATISTICS" tab and "BIG 3" tab respectively.

• By selecting exercises on the workout detail page for the specific day, and then clicking the start voice partner button, you can use the voice partner for the selected exercises.

  • It may took while for the voice partner to be loaded. Please wait until the voice partner starts(it will automatically starts).

Testing

To test the frontend side of the application, run the following commands on the fitvoxfrontend directory.

# yarn add coveralls
yarn test --coverage --watchAll=false

To test backend side of the application, run the following commands on the fitvoxbackend` directory. Make sure that your python version is more than 3.7.0.

# pip install coveralls
# If error related to db happends, please run following two commands first.
# python3 manage.py makemigrations
# python3 manage.py migrate
coverage run --source='./Fitvox' manage.py test

You can test the password reset system now, but as the server is inactive for now, the actual server name is not input yet. To test the password reset system, from the following email received,

You're receiving this email because you requested a password reset for your user account at localhost:8000.

Please go to the following page and choose a new password:

http://localhost:8000/password/reset/confirm/{uid}/{token}
Your username, in case you've forgotten: davekjh1123

Thanks for using our site!

The localhost:8000 team

You have to manually change the http://localhost:8000/ to http://localhost:3000/ from the link after clicking. The link is only valid for ONE change, and any further attempts would result in nothing. Also, there is currently no method in the given library to disable random inputs for opening the form. Therefore, clicking the link afterwards does result in opening the password reset form, but does not function, as the token is invalid afterwards. Please get another token by re-entering the email to the reset form.