Skip to content

RahmaIb/ChirpCheckApp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ChirpCheckV2

Created by Duck Squad 🦆


Project Description

ChirpCheck is the ultimate student study app and all-in-one productivity tool designed to meet the everyday needs of high school and college students. It’s a simple yet fun app that helps students stay productive while keeping them motivated. What makes ChirpCheck unique is its tailored approach and the encouragement built into the experience.

We aim to turn studying into a more engaging and encouraging experience by helping students stay organized, avoid missing deadlines, and manage their time better with a duck friend 🦆✨.


Contributors

🌟 Meet the Team 🌟


🛠️ Technology Stack

  • Java
  • IntelliJ
  • JavaFX
  • SceneBuilder
  • Git + Github (for version control)

How to Intall & Run

Prerequisites

  • IntelliJ
  • JDK 8 or higher
  • Maven

Step 1: Open IntelliJ & Clone

Launch IntelliJ

Click on 'Clone Repository...'

Clone using this URL:

https://github.com/UTSA-CS-3443/ChirpCheckV2

Step 2: Run HelloApplication.java

Click src > main > java > ducksquad.chirpcheck > HelloApplication.java

Click the green ▶️ play button in IntelliJ

Note

You can either create a new account or login as a test user.

Username: test

Password: 1234


UML Diagram

UMLFinalAPP.pdf


Features / How to use?

▶️ Login Screen

The user creates an account and then the user will input their username and password in order to access their duck.

🦆 Main Menu Screen (Duck Home)

Welcome to the home for your duck! The main menu allows you to navigate through all features of the application. Here you will be able to see the accessories that have been bought from points earned after completing tasks.

📚 Flashcards

The user can choose to create or select a deck and open it. They can parse through the deck or edit by adding more cards or choosing to delete the deck.

📋 To-Do-List

Displays a list of all inputted tasks with dates. Once tasks have been completed the user will click on the egg which will become an hatched egg and 1 completed = 10 EggsP. Also, there a randomly generated motivational quotes with the mascot duck that update every time you visit the page!

📈 Productivity Statistics

This screen shows how many tasks have been completed, how much progress the user has made, compares how many tasks the user has completed to the prior week, and there are more awesome randomly generated motivational quotes!!

⌛ Timer

Users can create a customizale timer, which can be played in the background while working on other screens, including Focus Mode. It can start, stop, reset, and show the time in minutes. Once finished the animated bar will reach the end and a ringtone will be played.

🎩 Customizer

This screen will allow the user to choose clothes or furniture for their duck. Accessible options are dependent on how many eggs have hatched (how many tasks have been completed). Items will be displayed on the Main Menu.

🙈 Focus Mode Screen

This will take up the users entire screen when enabled, stoping them from unncessary distractions.

🤜🤛 Credits Screen

Where you can meet the team behind this amazing app. Here all the team members and their roles are displayed.


🪰Bugs & Issues🐛

While going through the application you may notice some small bugs (or you may not). Some known issues include

  • EggsP + Customizing: After buying an item, when logging out and logging back in the EggsP may sometimes refresh to the state before buying the item, thus giving you some free extra points. This does not happen consistently (only for our favorites 🤭).

🔮 Future Enhancements

While this app is already pretty awesome, there are a few things we could do to make it even better:

  • Flashcards: Have the decks and cards automatically refresh instead of having to manually refresh the pages.
  • Timer: Allow user to completly close timer and still have it run in background allowing for usage of just 1 window instead of multiple.
  • Task Notifications: As you near a due date, you should be reminded of whatever task is due.
  • UI/UX : Have a color pallet more accommodating and suitable to different user's needs. Include accessability feature such as contrast or "theme" changers, as well as screen readers.
  • Make the To-do List time and date format more "giving", as per the peer evalution survey.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors