Skip to content

Commit 7717fef

Browse files
committed
Updated Readme
1 parent 3ffab8a commit 7717fef

File tree

2 files changed

+93
-2
lines changed

2 files changed

+93
-2
lines changed

README.md

+92-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,94 @@
11
# 🏗 KiddoPerks
22

3-
Family-focused DApp named KiddoPerks that rewards kids with a custom digital token for completing household and school tasks. Using blockchain, it ensures transparency and teaches financial skills in a fun, gamified way.
3+
**KiddoPerks** is a **task-based allowance** platform designed to teach children about responsibility, money management, and financial education, using **blockchain** to ensure transparency and traceability of rewards. Parents can register household and school tasks completed by their children, rewarding them with digital tokens that can be redeemed for family activities or rewards.
4+
5+
## Features
6+
7+
- **Task Registration**: Parents can create a list of tasks for their children, assigning a monetary or token value to each.
8+
- **Digital Rewards**: Upon completing tasks, children earn digital tokens which can be redeemed for rewards or family activities.
9+
- **Transparency and Traceability**: By using blockchain, all tasks and rewards are recorded immutably, ensuring transparency and trust.
10+
- **Financial Education**: Through this system, children learn basic financial concepts, such as saving and responsible spending.
11+
12+
* **Family Dashboard**: Parents have access to a dashboard where they can track their children's progress and adjust tasks and rewards.
13+
14+
## Technologies
15+
16+
- **Blockchain**: Used to record completed tasks and rewards, ensuring transparency.
17+
- **Smart Contracts**: Manage the reward system and creation of family tokens.
18+
- **ScaffoldEth**: Framework used to build the user interface of the web platform.
19+
20+
## Installation
21+
22+
1. Clone the repository:
23+
24+
```bash
25+
git clone https://github.com/danitome24/bc-kiddo-perks.git
26+
```
27+
28+
2. Install dependencies
29+
Navigate to the project directory and install the required dependencies:
30+
31+
```bash
32+
cd bc-kiddo-perks
33+
yarn install
34+
```
35+
36+
## Set up environment variables
37+
38+
Ensure you have set the necessary environment variables for interacting with the blockchain (e.g., Infura API keys, contract addresses, etc.). Create a .env file in the root of the project and add the following information:
39+
40+
```
41+
REACT_APP_INFURA_URL=<Your Infura URL>
42+
REACT_APP_CONTRACT_ADDRESS=<Your Smart Contract Address>
43+
REACT_APP_PRIVATE_KEY=<Your Wallet Private Key>
44+
```
45+
46+
## Start the development server
47+
48+
Once the environment variables are set, you can start the development server to run the app locally:
49+
50+
```bash
51+
yarn start
52+
```
53+
54+
The app will be available at http://localhost:3000.
55+
56+
## Usage
57+
58+
1. **Register Tasks**: Parents can create tasks from the dashboard, assigning a token value to each.
59+
2. **Complete Tasks**: Children mark tasks as completed, and the system validates them, awarding the corresponding tokens.
60+
3. **View Rewards**: Children can see their accumulated tokens and redeem them for rewards defined by their parents.
61+
4. **View History**: Parents can review the history of tasks and rewards through the dashboard.
62+
63+
## Smart Contracts
64+
65+
The system uses smart contracts to manage tasks, rewards, and tokens. Be sure to deploy and link the contracts properly on the blockchain for the functionalities to work.
66+
67+
## Deploying Smart Contracts
68+
69+
1. Compile and deploy contracts:
70+
71+
```bash
72+
yarn chain
73+
```
74+
75+
```bash
76+
yarn deploy --reset
77+
```
78+
79+
2. Configure contracts: Make sure the contracts are correctly set up to interact with the frontend.
80+
81+
## Contributing
82+
83+
If you'd like to contribute to this project, please follow these steps:
84+
85+
1. Fork the repository.
86+
2. Create a new branch `git checkout -b feature/my-new-feature`.
87+
3. Make your changes and ensure the code is well-tested.
88+
4. Commit your changes `git commit -am 'Add new feature'`.
89+
5. Push to the branch `git push origin feature/my-new-feature`.
90+
6. Open a pull request describing the changes you've made.
91+
92+
## License
93+
94+
This project is licensed under the MIT License - see the LICENSE file for details.

packages/nextjs/components/kiddo-perks/ParentDashboard/RecentActivitySummary.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ export const RecentActivitySummary = () => {
5050
}));
5151

5252
setActivities([...perkRedeemedActivities, ...tokenMintedActivities].sort((a, b) => a.blockNumber + b.blockNumber));
53-
}, [perkRedeemedEvents, tokenMintedEvents]);
53+
}, [perkRedeemedEvents, tokenMintedEvents, children, perks]);
5454

5555
return (
5656
<section className="mt-6">

0 commit comments

Comments
 (0)