Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update to match main #34

Merged
merged 11 commits into from
Apr 24, 2024
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.
36 changes: 31 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# BraniacWiz QuizREADME.md
# BraniacWiz Quiz README.md

## 🤓 **Overview**

Expand All @@ -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**
Expand All @@ -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**:

Expand Down Expand Up @@ -73,13 +76,36 @@ 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 <SUBGRAPH_SLUG>
```
- 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.`

### 📝 **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
Expand All @@ -90,5 +116,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