Skip to content

Latest commit

 

History

History
542 lines (326 loc) · 26.3 KB

README.md

File metadata and controls

542 lines (326 loc) · 26.3 KB

📔 Table of Contents

🌟 About the Project

Extensive research highlights a pressing need to enhance financial literacy among young individuals. PLEARN, our blockchain-based virtual board game, addresses this gap by delivering financial education in an engaging manner. Our aim is to equip the youth with essential financial skills, reducing costs related to financial management, enhancing financial safety nets, and ensuring financial security. A growing divide exists between the financial responsibilities placed on young individuals and their ability to make informed financial decisions. PLEARN acts as a bridge to close this gap and empower the youth to make wise financial choices, understanding that the key to financial freedom lies in making your money work for you, not just earning more. Through PLEARN, players gain hands-on experience in managing finances by investing, trading, and real estate transactions.

💣 Problems

  • Basic knowledge: 1 in 5 teens lacks a basic foundation to build on for financial literacy.

  • Spending: Annual wasteful consumption of youth (under 39) is approximately $11.7 billion

  • Managing: 74% of teens don’t feel confident about their financial education.

  • Lack of sustainable finance literacy in school

  • The gap between the amount of financial responsibility given to the young and their demonstrated ability to manage financial decisions and take advantage of financial opportunities, is rapidly widening. Unless significant action is taken to alter this, financial illiteracy will remain an obstacle to Millennials’ financial security and that is what we are trying to solve through PLEARN.

👩‍💻 Solution

The Edutainmetn solution we are providing to the market through our game, PLEARN, is a unique and engaging approach to financial education. PLEARN leverages blockchain technology to create a virtual board game that offers players a hands-on experience in managing their finances. It addresses the pressing need for improved financial literacy, especially among the youth.

Through PLEARN, players learn essential financial skills by participating in activities such as investing, trading in both stock and cryptocurrency markets, and purchasing real estate. This immersive experience is designed to make financial education fun and relatable, encouraging players to make informed financial decisions.

By combining entertainment with learning, PLEARN helps users minimize costs associated with financial products, strengthen their financial safety net for emergencies, and ultimately enhance their financial security. Our solution aims to empower individuals to take charge of their financial futures by making their money work for them, a key aspect often overlooked in traditional financial education. PLEARN is a pioneering and interactive tool for building financial literacy and helping individuals achieve financial freedom.

A Blockchain based-platform

- Integrates: NFT, real estate, and auction marketplace

Gamification

- Designs: optimal UI, interactive, and creative learning activities through gaming in P2E, P2P, socialisation modes

Built in Metaverse

- Interoperability: reflecting the real world activities such as social interactions, lifelike experience, and new opportunities for financial gains

As first step of developing the game, we will start with developing the first pillar; the Real Estate.

Real-Estate deals Properties

Contains deals relating to buying (minted) and renting (unminted) of virtual lands and properties.

- Commission to Land/property owner

Land is owned by a landowner if it has been bought. The landowner may choose to hold the property or rent it out, for doing so, they may extract a commission, in which case this is deducted automatically. By default, the commission is set to 10% on all Land NFTs and this is configurable by the landowner.

- Modifications to Land NFTs

  • Ability to ‘name’ land
  • Ability to sell advertising links on land
  • Ability to change Land Rating with
  • Ability to rent it out and sell it back

- Public Property the assets which belong to the game, which help game providers to supply the resources and facility to support the users to build their network, connect with the experts, and reuse the knowledge.

- Private Property The assets which users can buy land and build their own properties (coffee shops, car producers)

- Commission to Land/property owner Land is owned by a landowner if it has been bought. The landowner may choose to hold the property or rent it out, for doing so, they may extract a commission, in which case this is deducted automatically. By default, the commission is set to 20% on all Land NFTs and this is configurable by the landowner.

🔗 Deployed Dapp URL

(https://incredible-liger-fb1306.netlify.app/)

Screenshot 2023-10-29 at 22 53 09 Screenshot 2023-10-29 at 22 53 30 Screenshot 2023-10-29 at 22 54 27

📷 Screenshots

👾 Tech Stack

Client
Database
Backend
Web3
  • Hardhat
  • Chainlink
  • Etherjs
    AWS Tools
    • Amazon Elastic Compute Cloud (EC2)

    • AWS Identity and Access Management (IAM)

    • AWS Elastic Beanstalk

    • Legal Entity Identifier (LEI)

    • Legal Entity Reference Data (LE-RD)

    Challenges and Solutions 1- Airdrops:
      - Solution: We have used chainlink to automate the "airdrop" function of the smart contracts
    

    2- AWS:

     - The varities AWS provide in terms of tools, databases and products,creates a difficulty in choosing the right tool for the project.
       Solution: We start with databases relating to the environment topics, which can narrow down the confusion and timing.
    

    🐙 Polkadot ink bounties!

    1- Polkadot Bounty

    Most Innovative ink! dApp All dApp categories are eligible. Porting EVM apps and deploying with ink! is allowed as well. Be creative!

    We expect to see well written Readme explaining what the projects are about and how their implementations were made.

    Decentralized Identity: Polkadot's identity management can be integrated to offer players secure and user-friendly login credentials. This will provide enhanced security and privacy, allowing players to maintain control over their in-game achievements and assets. Decentralized Identity for Characters: Using Polkadot's decentralized identity solutions, players can have secure and user-friendly login credentials for their in-game characters. This provides additional security and a more personal connection to their avatars. Community Governance for Character Development: Implementing Polkadot's governance features can enable players to propose and vote on character changes or additions. This creates a sense of ownership and collaboration within the gaming community, allowing players to shape the future of in-game characters. Cross-Chain Character Adoption: PLEARN can use Polkadot's cross-chain capabilities to introduce characters from other blockchains. For instance, characters or avatars from other Polkadot-based games could become accessible in PLEARN, enhancing the diversity and appeal of in-game characters.

    2-AZERO.ID

    Best project using ink!athon or AZERO.ID bounty

    In PLEARN, we'll use the ink!athon framework to streamline our dApp development. This integration will greatly expedite our game's feature development and enhance its modularity. For example:

    Using AZERO.ID will enable us to tie an identity to each player persona, so the player will be able to change or add other blockchain addresses in the future. Game Assets and NFTs: Using ink!athon, we can quickly create, manage, and trade in-game assets as NFTs. These assets will be securely recorded on the Polkadot network, ensuring true ownership and provable scarcity. This integration not only simplifies our asset management but also gives players more confidence in the value of their in-game holdings. AZERO.ID Integration: We'll incorporate AZERO.ID to create a secure and user-friendly environment for player identity management. Players will have their unique domains, strengthening the connection between their in-game personas and their real-world identities. Team Collaboration: We'll use the ink!athon framework to foster team collaboration within the development process. This will expedite our feature development and create a more engaging and dynamic game environment for players.

    3- Aleph Zero

    Integrating Aleph Zero and ink! into PLEARN can offer unique character ownership through NFTs, enabling character-specific benefits within the game. Furthermore, by connecting to Aleph Zero's DeFi ecosystem, we can create innovative financial applications within the game, allowing players to explore financial management, investments, and other DeFi functionalities through their in-game characters and assets. This integration can enhance user experiences and financial literacy.

    4- ASTAR

    Participating in the ASTAR bounty is an excellent opportunity to strengthen the character part of your game and leverage the blockchain's capabilities to provide secure and verifiable character ownership, transactions, and marketplace interactions. This aligns with PLEARN's concept of combining financial education with an immersive gaming experience.

    How to Integrate:

    Ink! Smart Contracts for NFT Characters: Develop ink! smart contracts that represent the in-game characters as NFTs. This establishes a blockchain-backed ownership system.

    User-Friendly Interface: Create an intuitive and user-friendly interface for managing characters. Ensure that players can easily view, trade, or customize their NFT characters.

    Innovative Backend: Make use of ink! for efficient backend processes. Ink! is known for its scalability, which can support the large number of in-game characters and transactions.

    Beneficial Outcomes:

    Enhanced Ownership: Players will have verifiable ownership of their in-game characters through blockchain NFTs.

    Secure Transactions: All character transactions, including trading or customization, can be conducted securely on the blockchain.

    User Engagement: The ability to own, trade, and customize characters can boost user engagement.

    Marketplace Opportunities: With NFT characters, you can create a character marketplace, allowing players to buy, sell, or exchange characters, introducing new revenue streams.

    Blockchain Security: By integrating with ink!, you reinforce trust and confidence among players, as character ownership is securely recorded on the blockchain.


    Stages of a proposal

    Game’s style

    The idea of the game is a type of set collecting, where users collect assets (real estate, stocks, auction deals) to complete, tasks, missions and levels.

    Game’s setting:

    Soloplayer setting on one board

    End-game goals Knowledge:

    The end-game goals of PLEARN, in terms of knowledge, are to equip players with comprehensive financial literacy and empower them with practical skills for managing their finances effectively. These goals include:

    • Investment Literacy: Players should gain a deep understanding of various investment opportunities, including stocks, cryptocurrencies, and real estate. They should be able to evaluate investment options, assess risks, and make informed decisions to grow their wealth.

    • Financial Decision-Making: PLEARN aims to enhance players' abilities to make sound financial decisions. This includes budgeting, saving, and making choices about spending, all based on a solid financial understanding.

    • Risk Management: Understanding financial risk is essential. Players should be able to assess and mitigate financial risks associated with investments and be prepared for unexpected financial challenges.

    • Asset Management: By the end of the game, players should be proficient in managing their assets, which may include optimizing investment portfolios, property management, and wealth diversification.

    • Long-Term Financial Planning: PLEARN encourages players to consider their long-term financial goals, such as retirement planning, and how to create a sustainable financial future.

    • Blockchain and Cryptocurrency Knowledge: For players to fully grasp the potential of blockchain technology and cryptocurrencies in today's financial landscape.

    Game Components

    The game components of PLEARN include various elements that contribute to the gaming experience and the learning of financial literacy. These components are designed to engage players and provide opportunities to gain practical knowledge about finance, investments, and asset management. Here are the key game components:

    • Game Board: A virtual game board that serves as the central gameplay area, where players navigate through financial scenarios and investment opportunities.

    • Game Tokens: Virtual tokens representing players on the game board. These tokens are moved to different spaces as players progress through the game.

    • Assets: These represent the financial resources available to players. Assets can include virtual currency, stocks, cryptocurrencies, and real estate properties.

    • Market Spaces: Spaces on the game board that simulate real-life financial markets, such as stock exchanges and cryptocurrency markets. Players can buy and trade assets here.

    • Event Cards: These cards introduce random financial events and challenges that players must navigate. Events can include market fluctuations, investment opportunities, and unexpected expenses.

    • Mission Cards: Missions are financial challenges and tasks that players must complete to gain rewards and advance in the game. These missions relate to different aspects of financial literacy.

    • Player Profiles: Each player has a virtual profile that tracks their progress, investments, and financial decisions throughout the game.

    • Blockchain Integration: This unique component allows players to experience real ownership of in-game assets by leveraging blockchain technology. It provides transparency and security to in-game transactions.

    • Educational Content: Alongside the game, educational content is provided to players. This can include explanations, tutorials, and real-world financial tips to enhance financial literacy.

    • Leaderboards: A feature to track player performance and achievements. It encourages competition and motivation to improve financial knowledge.

    Game Setup:

    1. Wallet Connection: Users can integrate their MetaMask Wallet seamlessly into the platform. This wallet connection will be essential for managing in-game assets and transactions.

    2. In-Game Currency: PLEARN primarily operates with USDT (Tether) as the in-game currency. If users do not possess USDT, they can convert their fiat currency into USDT within the platform. Alternatively, users can deposit their existing USDT to initiate their financial adventures.

    3. Avatars as NFTs: User profiles, represented as avatars, are unique NFTs (Non-Fungible Tokens). Players have the flexibility to incorporate their pre-owned NFTs into the game. Additionally, they can mint brand-new avatars directly within the platform. This NFT integration adds a personalized touch to the gaming experience.

    4. Transaction Fees: For every financial move within the game, players will encounter transaction fees. The specific percentage for these fees is under consideration, ensuring a balance between fair gaming and platform sustainability.

    Game Phases:

    Phase 1 PvE (Players vs Environment): in this phase players will be playing against the environment, so, there will be no interaction with other players. Phase 2: PvP (Player vs Player): players will interact with each other. This mode will be unlocked after the player finishes PvE mode. Once players arrive in this phase, they will be able to buy & sell between each other.


    Challenges we ran into

    • Technical Hurdles: Developing a blockchain-based game can be technically complex. Integrating smart contracts, ensuring security, and handling transactions require a deep understanding of blockchain technology.

    • User Experience: Balancing educational content with engaging gameplay is challenging. Ensuring that users both learn and enjoy the game can be tricky.

    • Funding: Game development can be expensive. Securing funding and managing the budget effectively is a common challenge.

    • Testing and Bugs: Thorough testing is crucial. Identifying and fixing bugs, especially in blockchain interactions, can be time-consuming.

    • User Adoption: Getting users to adopt a new game, especially in the educational sector, can be a challenge. Effective marketing and user onboarding are key.

    • Content Development: Creating engaging and informative content for financial education is a challenge in itself.

    • Scalability: As your user base grows, ensuring the game can scale effectively is vital.

    Accomplishments that we're proud of

    • Innovative Concept: Creating a unique blockchain-based game that combines financial education and entertainment, which is a novel concept.

    • Educational Impact: Receiving positive feedback from users or educational institutions about the game's effectiveness in teaching financial literacy.

    • Growing User Base: Achieving significant user adoption and a growing player community.

    • Blockchain Integration: Successfully integrating blockchain technology, enabling true ownership of in-game assets, and fostering a sense of ownership.

    • NFT Integration: Allowing users to incorporate their NFT avatars into the game and potentially mint new ones on the platform.

    • Community Engagement: Building an engaged and supportive user community around the game.

    • Milestones Reached: Meeting development milestones and staying on track with the project timeline.

    What we learned

    • User Engagement: Understanding the importance of user engagement in educational gaming and how to design game mechanics that keep players motivated and eager to learn.

    • Blockchain Integration: Gaining insights into the challenges and benefits of integrating blockchain technology into a game, especially related to asset ownership and security.

    • Financial Literacy: Recognizing the significance of financial literacy and the need for innovative solutions to address this gap, particularly among the youth.

    • Community Building: Learning how to build and maintain an active and engaged user community around your game, fostering a supportive environment.

    • Educational Impact: Evaluating the effectiveness of your game as an educational tool and understanding how players respond to different teaching methods.

    • NFTs and Avatars: Exploring the possibilities of incorporating NFT avatars into the game, minting new NFTs, and the potential for player customization.

    • Regulatory Challenges: Navigating the regulatory landscape surrounding blockchain-based games and financial education applications.

    • Funding and Partnerships: Identifying the importance of securing funding and establishing partnerships to support the game's growth and development.

    What's next for PLEARN?

    PLEARN

    • User Growth: Concentrate on expanding your user base by marketing your game to educational institutions, youth organizations, and individuals interested in financial literacy.

    • Content Expansion: Develop additional in-game content and missions to cover more financial concepts and offer a more comprehensive learning experience.

    • Blockchain Integration: Explore more features related to blockchain technology, like NFTs and DeFi, to keep your game up-to-date with the latest financial trends.

    • Monetization Strategies: Refine your monetization strategy by evaluating different pricing models, in-game purchases, or even subscription options for players.

    • Community Building: Foster a strong user community around your game, encouraging users to share experiences, provide feedback, and support each other in their financial literacy journeys.

    • Partnerships: Seek partnerships with financial institutions, educational organizations, and blockchain projects to enhance the reach and impact of your game.

    • Feedback and Iteration: Continually gather user feedback to make improvements and updates, refining the game's mechanics and educational content.

    • Research and Analytics: Invest in data analytics and user research to understand how players engage with your game and what areas of financial literacy need more focus.

    • Scaling: As your user base grows, consider scalability options for your platform to accommodate increased traffic and maintain a smooth user experience.


    🎨 Color Reference

    Color Hex
    Primary Color rgb(191,214,246
    Secondary Color rgb(141,189,255)
    Text Color rgb(100,161,244)

    🔑 Environment Variables

    To run PLEARN, you will need to add the following environment variables to your .env file

    API_KEY

    ANOTHER_API_KEY

    🧰 Getting Started

    ‼️ Prerequisites

    This project uses Node as package manager

     npm install

    ⚙️ Installation

    Install dependencies with npm

      npm install 
      cd app/client

    🏃 Run Locally

    Clone the project

      git clone [(https://github.com/CryptoStein-PLEARN/LUMOS-HACKATHON/blob/main/README.md)]

    Go to the project directory

      cd app/client

    Install dependencies

      npm install

    Start the server

      npm run client

    🚩 Deployment

    To deploy this project run

      npx hardhat deploy

    🤯 Smart Contracts

    • TO BE FILLED

    🧭 Roadmap

    • ✅ Readme
    • ✅ Canva sketching
    • ✅ Front-end design
    • ✅ AMBI token smart contract
    • ✅ Marketplace Smart Contract
    • ✅ Hardhat deployment
    • ✅ Demo video

    👋 Team

    Member Title Description Linkedin GitHub
    Nada Jabr Project Leader Manage project content https://www.linkedin.com/in/nada-jabr-15838b39/ NJ-2021 - CryptoStein
    Beshoy Shehata Tech Lead Coordinate the project technicals https://www.linkedin.com/in/beshoy// 0xBeshoy
    Ujjwal-webdev Game developer Designing the game board https://www.linkedin.com/in/ujjwal-sachdeva-5064651b4/ ujjwal-webdev
    Sanskar-tyagi Front-End Deve. ESGROW front-end desing https://www.linkedin.com/in/sanskar-tyagi-953a921b1/ Sanskar-tyagi
    Rawan Mohsen Product Owner Team coordinator https://www.linkedin.com/in/rawan-mohsen-74563718b/ rawanmo7sen

    🤝 Contact

    🔗 Useful Links

    https://plearngame.netlify.app/

    • 🎦 Demo

    https://www.loom.com/share/244e002e8c5641f88377982e65d079ee?sid=d2cc4f25-5524-4174-9971-def84109f100

    💎 Acknowledgements