Chore Wars is a web application make chores fun and easier to manage. To split chore with ease on your household and to track the chores of your family members. This also features a leaderboard to create friendly competitions and to make chores fun and enjoyable!
Chore Wars is built using these technologies:
All icons used on Chore Wars are from Flaticon (UIcons) and Heroicons
- Clone the repository
git clone https://github.com/Ayessaaa/ChoreWars
- Go to the directory
cd ChoreWars
- Install dependecies
npm install
- Create your own cluster on MongoDB Atlas
ChoreWars Project -> ChoreWars
- Create a database on that cluster
ChoreWars Project -> ChoreWarsCluster -> ChoreWarsDB
- Create your .env file and paste you DBURI, secret, and cloudinary credentials
DB_URI=
secret=
CLOUD_NAME=
CLOUDINARY_KEY=
CLOUDINARY_SECRET=
- Start the Nodemon
nodemon app
Chore Wars is built to be compatible on both mobile and desktop devices.
This enables users to create and open their own accounts.
Session - This makes the user stay logged in for a while.
Password hashing - This makes the password get hashed when going to the database and when comparing it. Makes the authentication process more secure
When signing up, the application assumes that the user is an admin and makes the user the head of a household
This enables admin to create their own household that they will manage and create users for the household
Navbar - This shows menu and pages to explore from.
Family Members - This shows the lists of family members that are in this household. Each member has a link that they can use to edit their profile and get verified. You can add more members by clicking the add member button.
Chores - This shows the lists of chores that the household has. You can add more chores by clicking the add chores button.
This allows the admin to add chores and the chore details
This lists all the chores of the household and its details. You can add more chores by clicking the add chores button.
- You can edit the chores details
- You can delete the chore
This allows the admin to edit the chores details such as the chore name, frequency, points, and chore doers.
The Chore feed shows the recent chores your family members did. Every chores to be marker as done needs an image or proof that they did their chore to avoid chore fraud 😍. And to also motivate other fam members while also tracking the chores and creating memories.
The Leaderboard shows the ranking of yiur family members based on their chore points. Each point is earned by completing a chore and the point that is earned is according to the point of that chore that is given by the household admin
🔗 Join Link* - Share this link to the family member to set up their profile and to get their account verified*🗑️ Delete** - This deletes the selected user
This allows the user to set up their profiles and to be verified. After setting up their profile, they can now sign in using those credentials.
To-Do Chores - This lists all the chores that you have to accomplish today and also the chores that you failed to do before. This shows both to-do and over due chores.
Leaderboard - This shows the ranking of the family members based on points.
Chore Feed - This shows the recent chore pictures that the family members did.
This shows all the chores they need to accomplish. The chores db updates when the user logs in. Additionally, this also shows the overdue chores that the user failed to accomplish.
The Chore feed shows the recent chores your family members did. Every chores to be marker as done needs an image or proof that they did their chore to avoid chore fraud 😍. And to also motivate other fam members while also tracking the chores and creating memories.
The Leaderboard shows the ranking of yiur family members based on their chore points. Each point is earned by completing a chore and the point that is earned is according to the point of that chore that is given by the household admin
This allows the user to change their profile picture and full name.
I have used ChatGPT to help me from some code, debugging, and ideas for some parts of the project. Additionally, here are some resources that helped me create Chore Wars:
- Gradient Divs
- Checkbox
- Tooltips
- Log In, Sign Up
- Hashing Passwords
- Session Managment
- Cloudinary Image Upload
- Image Preview
Icons that were used in this website are:
- Flaticon
- Heroicons
Images that are used on the snapshots of the website are from pinterest
- Better username/ sign up for family members to lessen bugs
- Better today/ overdue chores algorithm (For now, when the user logs in thats only when the algorithm runs)
- Rotation and individual chore type
This repo is open for contributions! Just fork the repository, create a new branch and open a pull request.
This project is licensed under the MIT License.