Skip to content

Latest commit

 

History

History
179 lines (124 loc) · 5.86 KB

README.md

File metadata and controls

179 lines (124 loc) · 5.86 KB

Brainic 🧠

brainic brainic Forks brainic Stars brainic Issues

Project Initiator

`

🌐 Links 🌐

🖥️ Video . 🔗 Website · 📂 Repo · 🚀 Got Issue

🚀 What is Brainic

Brainic is a web3 memory game application that helps improve the memory of individuals while wining tokes as a result. The application is designed to be played by anyone, regardless of their age or experience with memory games. The goal of the game is to help the player improve their memory, while also providing them with the opportunity to win tokens as a result.

The game is played by matching pairs of cards, with each card representing a different nft image challenge. The more pairs of cards the player can match, the more tokens they will win. In addition to the opportunity to win tokens, the game also provides the player with a chance to improve their memory skills. The application is available for free, and can be played on any web-enabled device.

🦋 Prerequisite

🛠️ Installation Steps

  1. Clone the repository
git clone https://github.com/sensurusirupus/brainic
  1. Change the working directory
cd brainic
  1. Start the local Hardhat node
npx hardhat node
  1. With the network running, deploy the contracts to the local network in a separate terminal window
npx hardhat run scripts/deploy.js --network localhost
  1. Start the app
npm run start

🎇 You are Ready to Go!

⚙️ Configuration

The chain ID should be 80001. If you have a localhost rpc set up, you may need to overwrite it.

Project Initiator

To deploy to Polygon test or main networks, update the configurations located in hardhat.config.js to use a private key and, optionally, deploy to a private RPC like Infura.

require("babel-register");
require("babel-polyfill");
const HDWalletProvider = require("@truffle/hdwallet-provider");
const fs = require("fs");
const privateKey = fs.readFileSync("secret.txt").toString();
module.exports = {
  networks: {
    development: {
      host: "127.0.0.1",
      port: 7545,
      network_id: "*", // Match any network id
    },
    matic: {
      provider: () =>
        new HDWalletProvider(
          privateKey,
          `**your matic private key here**`
        ),
      network_id: 80001,
      confirmations: 2,
      timeoutBlocks: 200,
      skipDryRun: true,
    },
  },
  contracts_directory: "./src/contracts/",
  contracts_build_directory: "./src/abis/",
  compilers: {
    solc: {
      optimizer: {
        enabled: true,
        runs: 200,
      },
    },
  },
};

👷 Built with

  • Solidity: as Main Coding Language for writing smart contract

  • ReactJs: as Main Coding Language for Creating The UI components (Front End)

  • Bootstrap: as Main Coding Language for styling UI components

  • IPFS: For Storing of files

  • Web3 Storage: For Storing of files

  • Github : For Repo Storage and source code management

  • Git : For Version Control System

📂 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  • Fork the Project

  • Create your Feature Branch (git checkout -b feature/AmazingFeature)

  • Commit your Changes (git commit -m 'Add some AmazingFeature')

  • Push to the Branch (git push origin feature/AmazingFeature)

  • Open a Pull Request

🧑🏻 Author

Sensurus Irupus

🤝 Support

🎀 Contributions (GitHub Flow), 🔥 issues, and 🥮 feature requests are most welcome!

💙 If you like this project, Give it a ⭐ and Share it with friends!

Made with Solidity and Javascript & ❤️