Skip to content

hvpham-yorku/Quick-Quacker-coding_Group-1

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Quacker

Quacker is a web-based task manager with gamification elements designed to help young adults organize their tasks in a fun and engaging way.

Motivation:

Quacker adds a unique twist to traditional task management by turning productivity into a game-like experience. Instead of viewing tasks as chores, users complete them to earn food and nurture their virtual duck, making organization more rewarding. Neglecting tasks can result in the duck acting sad, refusing to evolve, or reacting humorously to missed responsibilities. To encourage consistency to users, daily streaks will unlock special rewards based on task completion habits, reinforcing positive behaviour. The goal is to create an intuitive, feature-rich task manage that seasmlessly blends habit information, making productivity more enjoyable and effective.

Installation:

Build and run code on these programming languages:

JavaScript

A scripting language for adding interactivity

HTML

The markup language for structuring web pages

CSS

A styling language used to design and format web pages by controlling layout, colours, fonts, and animations

SQL

A database query language used to store, retreive, and manage data in relation databases

VS Code

An IDE used for various languages, coding and debugging Download: https://code.visualstudio.com/download

HTML, CSS and JavaScript do not need to be downloaded and can be coded on VS Code

Contribution:

Pull requests are not necessary if your code has been 100% bug free. For tasks, there will be issues open where each member will one to work on. To add features, make a new branch separate from the main branch when working on it.

We will be using the GitHub Flow branching strategy to work on this project, where features are worked on in separate branches and then merged in the main branch after testing. Make a pull request to get any other collaborator to review and discuss the feature before merging.

Click link for more info on GitHub Flow: https://docs.github.com/en/get-started/using-github/github-flow

How to Contribute:

1. Install Relevant software

Ensure you have the following on your computer:

  • VS Code

2. Clone the Repository

Clone the project by copying and pasting the command in the <> Code button, then open the project in VS Code

3. Get a task + make a branch

Assign yourself an issue, then make a branch to work on it. All branches should be named after the feature's name

4. Complete the task

After the branch is made, complete the task

Have your files be placed in the correct folders

Here is some resources to help get organized: https://mitcommlab.mit.edu/broad/commkit/file-structure/

5. Add and commit your code

Add and commit you code to the repo, then push it so it's in GitHub

Use the Source Control tab to easily add and commit with typing the commands

6. Create a pull request

Go to the GitHub repo and click on the pull requests tabs Create a new pull request with your branch merging into main

7. Discussion and Review

We will review and discuss our features, if they are able to be approved. Make changes and fix issues according to what was found in the discussions and review

Sprint 1:

Login and Sign-up

This feature is where users have to create an account using their email to use the application

Task Creation and Organization

This feature allows users to create tasks and organize based on their priorty of low, medium, or high

Virtual Pet Duck

This application has a virtual pet duck that currently levels up the more you play with it, other features related to the duck are coming in Sprint 2

Database

This is where accounts will be stored on the server.

Sprint 2:

Login and Sign-up

This feature is where users have to create an account using their email to use the application

Task Creation and Organization

This feature allows users to create tasks and organize based on their priorty of low, medium, or high. The features also organises task based on type(Finanical, School, Work, Personal, Health, Other) and status(Not Started, In Progress, Completed), and gives rewards when tasks are finished and marked as done. There is a due date and time associated with every task created. All tasks are stored locally.

Virtual Pet Duck

This application has a virtual pet duck that currently levels up the more you play with it. Duck can be customized with a name, gender, and different colours that can be bought with coins.

Database

This is where accounts will be stored on the server.

Calendar

This page has a built-in calandar, which marks dates with tasks that are due on that specified day. The bottom of the page displays the events of the day you are on.

Rewards

Completing tasks help gain XP, coins, achievements, streaks, completing a task increase you daily streak(which may give more rewards)

Settings

Allows user to customize duck's name, gender, and colour which is bought with coins

Play

In the duck tab, pressing send users to a minigame which completed will make the duck gain more XP.

About

project-quick-quacker-coding created by GitHub Classroom

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 6