From bd77509966cafe04d6370ee9fa5b08b23fc22669 Mon Sep 17 00:00:00 2001 From: CharlesLedwaba Date: Mon, 22 Apr 2024 23:51:35 +0200 Subject: [PATCH 1/7] Nothing is coming to mind on the additionals for the readMe assistance please --- README.md | 66 ------------------------------------------------------- 1 file changed, 66 deletions(-) diff --git a/README.md b/README.md index 5c7998f..7bbd572 100644 --- a/README.md +++ b/README.md @@ -1,67 +1 @@ ### BraniacWiz Quiz Game README.md - -🤓 **Overview** - -Welcome to the BraniacWiz Quiz Game, a decentralized application built on the Ethereum blockchain platform. This quiz game allows users to create and participate in quizzes while leveraging the security and transparency of blockchain technology. Dive into the world of decentralized quizzes and challenge your knowledge! - -👥 **Developers** - -- `coming soon` - -💡 **Purpose** - -- The BraniacWiz Quiz Game aims to provide an engaging and secure platform for users to create and participate in quizzes using smart contracts on the Ethereum blockchain. By leveraging blockchain technology, the game ensures transparency, immutability, and fairness in quiz interactions. -- It makes use of multiplayer schema to make the game even more interesting, where one can be the host, and others will join as players using the game pin generated by the host. - -🔧 **Installation and Setup** - -1. **Requirements**: - - Metamask browser extension - - Truffle framework - - Ganache for local blockchain development - -2. **Installation**: - - Clone the GitHub repository. - - Install project dependencies using npm: - ``` - $ npm install - ``` - -3. **Running the Game**: - - Start Ganache for local blockchain development. - - For development purposes, we use Genach as our main game wallet: - - Have Genach running. - -4. **Connecting Metamask**: - - Connect Metamask to the DApp and confirm account connection. - - Switch between accounts using Metamask for different interactions. - -🎲 **Usage Instructions (Player/Host)** - -- **Creating a Quiz**: - - Choose a role of a host and generate a game pin, and click next to host the quiz - - You will see a list of players as they join. - -- **Taking a Quiz**: - - Browse available quizzes, then click the one hosted by the host, - - Enter the game pin sent to you by the host. - - Pick the correct answers and at the end of the quiz, a scoreboard comparing you to other players will show. - - If you are on position one, you will receive 1 ETH token to your MetaMask wallet. - -- **Account Management**: - - Use Metamask to switch between accounts for different interactions within the game. - -⚠️ **Known Issues** - -- Grading the user's submitted answer choice. -- Awarding the winning user the pool amount. - -📝 **Additional Notes** - -- Ensure all dependencies are correctly installed for smooth operation. -- Connect Metamask to the DApp to manage your account and interact with the game seamlessly. -- Refresh the page to load account information and maintain a smooth user experience. - -🎮 **Explore the BraniacWiz Quiz Game** - -Enjoy a decentralized quiz experience like never before! Feel free to contribute, provide feedback, and engage with the developers to enhance the game further. From 505f5999c1f6ffdd9c49dbd91cf9cdf545de70db Mon Sep 17 00:00:00 2001 From: mmpotulo28 Date: Tue, 23 Apr 2024 10:20:39 +0200 Subject: [PATCH 2/7] fix --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 081055e..6cd48dc 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ <<<<<<< HEAD + ### BraniacWiz Quiz Game README.md -<<<<<<< HEAD -======= + +# <<<<<<< HEAD + ======= + # BraniacWiz QuizREADME.md ->>>>>>> 420992530a064c90384368d7e9dcb7d9a055f882 + +> > > > > > > 420992530a064c90384368d7e9dcb7d9a055f882 ## 🤓 **Overview** @@ -85,7 +89,7 @@ Welcome to the BraniacWiz Quiz Game, a decentralized application built on the Et ### 📝 **Additional Notes** -- Ensure all dependencies are correctly installed for smooth operation (`whe running locally`). +- Ensure all dependencies are correctly installed for smooth operation (`when running locally`). - Connect Metamask to the DApp to manage your account and interact with the game seamlessly. - Refresh the page to load account information and maintain a smooth user experience. - Make sure you are the `Celo alfajoris network` on your metamask wallet @@ -93,12 +97,8 @@ Welcome to the BraniacWiz Quiz Game, a decentralized application built on the Et ### 🎮 **Explore the BraniacWiz Quiz Game** Enjoy a decentralized quiz experience like never before! Feel free to contribute, provide feedback, and engage with the developers to enhance the game further. -<<<<<<< HEAD ->>>>>>> e125632b9297a1fdbcf3b8330f8fd6c3bb79cab1 -======= ## ⚠️ Issues reporting and Feature request - use this [link]() to report an issue to the game - use this [link]() to request a feature to the game ->>>>>>> 420992530a064c90384368d7e9dcb7d9a055f882 From 3ff04287b39bb72eda047097bb3c6227c9c60003 Mon Sep 17 00:00:00 2001 From: mmpotulo28 Date: Tue, 23 Apr 2024 10:23:41 +0200 Subject: [PATCH 3/7] fix issue --- README.md | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/README.md b/README.md index 6cd48dc..02a624e 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,4 @@ -<<<<<<< HEAD - -### BraniacWiz Quiz Game README.md - -# <<<<<<< HEAD - -======= - -# BraniacWiz QuizREADME.md - -> > > > > > > 420992530a064c90384368d7e9dcb7d9a055f882 +# BraniacWiz Quiz README.md ## 🤓 **Overview** From f4e0bff562859f285aa058095ba6ee0809e6fd65 Mon Sep 17 00:00:00 2001 From: CharlesLedwaba Date: Tue, 23 Apr 2024 11:06:12 +0200 Subject: [PATCH 4/7] Added the graph deployment details --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 02a624e..a56e840 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Welcome to the BraniacWiz Quiz Game, a decentralized application built on the Et ## 💡 **Purpose** -- The BraniacWiz Quiz Game aims to provide an engaging and secure platform for users to create and participate in quizzes using smart contracts on the Ethereum blockchain. By leveraging blockchain technology, the game ensures transparency, immutability, and fairness in quiz interactions. +- The BraniacWiz Quiz Game aims to provide an engaging and secure platform for users to create and participate in quizzes using smart contracts on the Celo Ethereum blockchain. By leveraging blockchain technology, the game ensures transparency, immutability, and fairness in quiz interactions. - It makes use of multiplayer schema to make the game even more interesting, where one can be the host, and others will join as players using the game pin generated by the host. ## 🔧 **Installation and Setup** @@ -23,6 +23,9 @@ Welcome to the BraniacWiz Quiz Game, a decentralized application built on the Et - Metamask browser extension - Truffle framework - Ganache for local blockchain development +- Visual Studio Code IDE +- Live Server extension + ### 2. **Installation**: @@ -73,6 +76,23 @@ Welcome to the BraniacWiz Quiz Game, a decentralized application built on the Et - Your tokens (NFTs) and transactions are linked to your wallet account, so keep your `MetaMask wallet` safe. - you access them from everywhere +### - **The Subgraph Utilization**: + +-The subgraph is created on subgraph studio at https://thegraph.com/studio/ using the Celo - alfajores. +- A subgraph is named BraniacWiz. +- To create the graph the steps to be taken are: +- On your local machine, run one of the following commands: +- npm install -g @graphprotocol/graph-cli +- Initialize your Subgraph using command: +- graph init --studio +- Then after writing the subgraph deploy to the subgraph studio. +- Once your subgraph is written , run the following commands: +- $ graph codegen +- $ graph build +- Publish Your Subgraph to The Graph’s Decentralized Network⁠. +- Query your Subgraph. +- With regards to this Web application the query to the subgraph is your wallet under transactions. + ### ⚠️ **Known Issues** - `WE A RUNNING A BUG-LESS GAME! UNFORTUNATELY.` From c27569fb335365d2831455c92c773fc2ebe9645e Mon Sep 17 00:00:00 2001 From: Manelisi Mpotulo Date: Tue, 23 Apr 2024 13:14:02 +0200 Subject: [PATCH 5/7] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. From 9c4941f908a4198f617f6c4691a7700575d8d012 Mon Sep 17 00:00:00 2001 From: Manelisi Mpotulo Date: Tue, 23 Apr 2024 13:15:07 +0200 Subject: [PATCH 6/7] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a56e840..8ff0893 100644 --- a/README.md +++ b/README.md @@ -110,5 +110,5 @@ Enjoy a decentralized quiz experience like never before! Feel free to contribute ## ⚠️ Issues reporting and Feature request -- use this [link]() to report an issue to the game -- use this [link]() to request a feature to the game +- use this [link](https://github.com/CPUT-DEVS/devpost-hackathon/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=) to report an issue to the game +- use this [link](https://github.com/CPUT-DEVS/devpost-hackathon/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=) to request a feature to the game From 1769c0abe2ac5194db1938d0be3eafcfd411d5fc Mon Sep 17 00:00:00 2001 From: Manelisi Mpotulo Date: Tue, 23 Apr 2024 19:33:14 +0200 Subject: [PATCH 7/7] Update README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8ff0893..98d1058 100644 --- a/README.md +++ b/README.md @@ -82,13 +82,19 @@ Welcome to the BraniacWiz Quiz Game, a decentralized application built on the Et - A subgraph is named BraniacWiz. - To create the graph the steps to be taken are: - On your local machine, run one of the following commands: -- npm install -g @graphprotocol/graph-cli + ``` + npm install -g @graphprotocol/graph-cli + ``` - Initialize your Subgraph using command: -- graph init --studio + ``` + graph init --studio + ``` - Then after writing the subgraph deploy to the subgraph studio. - Once your subgraph is written , run the following commands: +``` - $ graph codegen - $ graph build +``` - Publish Your Subgraph to The Graph’s Decentralized Network⁠. - Query your Subgraph. - With regards to this Web application the query to the subgraph is your wallet under transactions.