Skip to content

Latest commit

 

History

History
89 lines (53 loc) · 3.45 KB

README.md

File metadata and controls

89 lines (53 loc) · 3.45 KB

Study Pet

Description

Study Pet is a React Native Expo application designed to help students manage their study time effectively. The app's goal is to encouraging students to study by tying the care of a virtual pet to their study habits, the more they study the happier their pet will be and the better it will grow.

Prerequisites

Before you begin, ensure you have met the following requirements:

  • You have installed the latest version of Node.js and npm
  • You have installed Expo CLI: npm install -g expo-cli
  • You have a Windows/Mac/Linux machine.

Installing Study Pet

To install Study Pet, follow these steps:

  1. Clone the repository: git clone https://github.com/uprm-inso4117-2023-2024-s2/semester-project-study-pet.git
  2. Navigate into the project directory: cd semester-project-study-pet
  3. Install dependencies: npm install

Using Study Pet

To use Study Pet follow these steps:

  1. Start the Expo server: npx expo start

Running on Android Emulator

  • Make sure you have Android Studio installed.
  • Setup an Android Virtual Device (AVD) in Android Studio. You can follow the instructions here.
  • Run the AVD.
  • Press a in your terminal after starting the Expo server to send the app to your Android emulator.

Running on iOS Simulator (Mac only)

  • Make sure you have Xcode installed.
  • Setup an iOS simulator in Xcode. You can follow the instructions here.
  • Press i in your terminal after starting the Expo server to send the app to your iOS simulator.

Running on Physical Device

  • Open the Expo client app on your iOS or Android phone.
  • Scan the QR code printed by npx expo start with Expo Go (Android) or the Camera app (iOS).

Running Tests

To run tests:

  1. Run the project on Phone or Web
  2. Find file name of the test (located in _tests_/)
  3. Run npx jest "filename" in the terminal

Feature Highlights!

PETS!

  • You can create pets and assign them specific assignments so they can help you study! You can choose from a variety of pets, including a Frog, a Penguin, A Dog, a Cat, and more! All with unique designs and expressions!

MINIGAMES!

To keep your pet healthy, clean, and entertained, play minigames which help you study for your assignments! Among these:

  • Bathing Minigame: Depending on chosen difficulty, you get 3-9 questions. Depending on how many you get correct you get to boost your pets happiness stat!

  • Eating Minigame: Your pet grows hungry over time, keep it satiated by partaking in a multiple choice flashcards minigame!

  • Playing Minigame: To keep your pet happy, play with it frequently by answering questions correctly in another multiple choice flashcards minigame!

AND MORE!

  • Special sound effects for minigames
  • Pet customization options
  • Shop to give your pet food and other items!
  • Stat menu to keep track of your pets
  • Mobile notifications to remind you of your Studypet!
  • Flashcard minigame creation and editing to suit your studying needs!
  • And so much more!

Milestone Bugs and Fixes

License

TODO: Add license