Skip to content

Study Buddy 1.0.0

Latest
Latest
Compare
Choose a tag to compare
@katrinajaneczko katrinajaneczko released this 02 May 02:26
1.0.0
119e716

Release notes - Study Buddy Virtual Pet - Study Buddy 1.0.0

README

Run Instructions

  • Please navigate to our app by clicking this link. (NOTE: DNS propagation takes a long time with Temple University so the link to the site will not work when using the school's wi-fi - tusecurewireless. Please connect from another network). Once there, you can create an account, select a pet, and explore the site.
  • Study Buddy is a Progressive Web App (PWA). This means it's a web site that you can use in your browser, or it can be downloaded to your device and used like an app.
    • On iOS: Open Safari and navigate to the site. Press the "Share" button and select "Add to Home Screen" from the popup. Lastly, tap "Add" in the top right corner to finish installing the PWA. It will now be on your home screen.
    • On Android: Open Chrome and navigate to the site. Press the "three dot" icon in the upper right to open the menu. Select "Add to Home screen." Press the "Add" button in the popup. The PWA is now installed and available on your home screen.
      Study buddy pwa instructions!

Local Build Instructions

Prerequisites

  • Python 3.8 or higher
  • pip3 22 or higher
  • npm 8 or higher

A secret key and a gmail password will be required in backend .env file for the project to run correctly. If you are an approved developer on this project, reach out to your team lead to receive the requisite credentials. Modification of the backend code source code will be required in order to send email verifications on user registration. Our team is happy to assist in guiding you through this process.

Set Up

  1. Download the zip file in the release and open. Open a terminal, then navigate to the project directory.

  2. Insert your development keys to <your-path>/project-virtual-pet/pocs-capstone/backend/backend/.env

SECRET_KEY=<YOUR-KEY>
GMAIL_PASSWORD=<YOUR-PASSWORD>
  1. Navigate to the backend:
cd <your-path>/project-virtual-pet/pocs-capstone/backend
  1. Activate a Python virtual environment and install dependencies:

(MacOS/Unix)

source tutorial-env/bin/activate
pip3 install -r requirements.txt

Windows

tutorial-env\Scripts\activate.bat
pip3 install -r requirements.txt
  1. Activate the backend with the following instructions:
python3 manage.py makemigrations
python3 manage.py migrate
python3 manage.py runserver
  1. Now, open a new terminal and from the project directory, navigate to the frontend:
cd <your-path>/project-virtual-pet/pocs-capstone/frontend
  1. Build the frontend as follows. Dependencies will be downloaded and compiled for you:
npm install 
npm run build 
nmp start
  1. In your browser, navigate in the search bar to http://localhost:3000.

Features

SB-24 Notification system for reminders

SB-80 Reorder/sort task list items frontend

SB-102 Tags for filtering tasks

SB-137 Tutorial

SB-154 Mobile Register/Login

SB-157 Mobile Account/Settings

SB-167 Create pet animation for onClick event

SB-169 Tasks can't be checked off as complete right away

SB-170 Update EXP bar

SB-172 Mobile CSS Fixes & Tweaks

SB-173 Implement mood descriptors

SB-176 Milestone Demo Rehearsal Deliverable - A

SB-178 Update Canvas Mobile Instructions

SB-180 Create OneSignal account

SB-182 Test Report - Acceptance Tests

SB-183 Make final release

SB-184 Revise/update past documentation

SB-185 Create mock Canvas data

SB-186 Replace Canvas course ID with name

SB-188 Easter egg: pet weight

SB-192 Create level up animation

SB-195 Reorder/sort task list items backend

SB-196 Scale pet up every 10 levels

SB-197 Pet rock pixel art

SB-198 Display pet mood in pet profile page

SB-199 Milestone Demo Rehearsal Deliverable - C

SB-200 Milestone Demo Rehearsal Deliverable - M

SB-201 Milestone Demo Rehearsal Deliverable - H

SB-203 Milestone Demo Rehearsal Deliverable - K

SB-208 Remove Docusaurus Tutorial

SB-209 Practice final demo -K

SB-210 Practice final demo -M

SB-211 Test Report - Integration

SB-212 Test Report - Unit

SB-190 Canvas button does not appear on first redirect (fixed bug)

SB-191 Update page display tabs to respect 'safe area' of devices

Known Bugs

SB-139 Timeout error

SB-146 Tab selection does not persist through screen width change

SB-160 Login after signup saves username which can't be used for login

SB-168 If task is due same day, the mood is negatively influenced

SB-204 Caching + Space Issue for VM/deployment

Assets 2