Skip to content
 
 

Repository files navigation

MindSnap

MindSnap is a next-generation, community-powered learning platform that gamifies education and rewards top performers. By integrating interactive quizzes, dynamic leaderboards, and blockchain-based incentives, MindSnap creates an engaging environment where users are motivated to learn, compete, and grow together.

alt text

Workflow

The following diagram illustrates the workflow of the project:

Workflow


Features

  • Interactive Quizzes:
    MindSnap offers a diverse set of quizzes across multiple subjects and difficulty levels. Each quiz is designed to challenge users and help them expand their knowledge base in a fun, interactive way.

  • Real-Time Leaderboards:
    The platform features both weekly and monthly leaderboards, allowing users to track their progress and see how they stack up against others in the community. Leaderboards update instantly as users complete quizzes and earn points.

  • User Profiles & Stats:
    Every user has a personalized profile displaying their name, wallet address, rank, and performance statistics. This transparency fosters healthy competition and personal accountability.

  • Blockchain-Based Rewards:
    Top learners are rewarded with tokens sent directly to their crypto wallets. The reward system is automated and transparent, leveraging blockchain technology to ensure fairness and security.

  • Hall of Fame:
    The Hall of Fame section highlights the top three performers in a visually distinct podium, celebrating their achievements and inspiring others to reach the top.

  • Responsive & Modern UI:
    Built with React and Tailwind CSS, MindSnap provides a seamless experience across devices, with visually appealing gradients, animations, and intuitive navigation.

  • Secure Authentication:
    User authentication and session management are implemented to protect user data and ensure a safe learning environment.


How MindSnap Works

MindSnap is designed to make learning both rewarding and competitive:

  1. User Journey:
    Users sign up and create a profile. Once authenticated, they can participate in quizzes, each contributing to their overall score.

  2. Quiz Mechanics:
    Quizzes are dynamically loaded and scored in real-time. The system tracks attempts, correct answers, and time taken, ensuring a fair assessment of each user's performance.

  3. Leaderboard Calculation:
    As users complete quizzes, their scores are aggregated and ranked. The leaderboards (weekly and monthly) are updated live, reflecting the most recent activity and performance.

  4. Reward Distribution:
    At the end of each leaderboard cycle, the top-ranked users are eligible to claim blockchain-based rewards. The platform integrates with wallet services to securely distribute tokens, with a dedicated claim interface for winners.

  5. Recognition & Motivation:
    The Hall of Fame and user profile stats provide ongoing motivation, while the competitive structure encourages consistent participation and improvement.


Installation & Setup

Follow these steps to set up MindSnap locally:

Tech Stack

  • Node.js (v18 or higher recommended)
  • npm or yarn
  • Python (v3.10+)
  • MongoDB (local or cloud instance)

1. Clone the Repository

git clone <your-repo-url>
cd MindSnap

2. AI Service Setup

You have two options for the AI service:

Option A: TypeScript AI Service (Recommended)

cd type-ai
# Install dependencies:
npm install

# Set up environment:
cp env.example .env
# Edit .env and add your GOOGLE_API_KEY

# Build and start:
npm run build
npm start

Option B: Python AI Agent (Legacy)

cd agent
# (Optional but recommended) Create a virtual environment:
python -m venv venv
# Activate the virtual environment:
# On Windows:
venv\Scripts\activate
# On macOS/Linux:
source venv/bin/activate

# Install dependencies:
pip install -r requirements.txt

Note: The frontend automatically uses the TypeScript AI service by default, with fallback to the Python agent if needed. See MIGRATION_GUIDE.md for details.

3. Frontend Setup (Next.js)

cd ../frontend
# Install dependencies:
npm install
# or
# yarn install

# Start the development server:
npm run dev
# or
yarn dev

4. MongoDB Setup

  • Ensure MongoDB is running locally or provide a connection string to a cloud instance (e.g., MongoDB Atlas).
  • Update the MongoDB connection string in the appropriate config file (e.g., frontend/app/config.ts or .env.local).

5. (Optional) Smart Contract/Blockchain Setup

If you want to work with blockchain rewards:

cd ../web3
# Install dependencies:
npm install
# Compile contracts:
npx hardhat compile
# (Optional) Deploy contracts to local/testnet:
npx hardhat run scripts/deploy.js --network <network>

Now you can access the frontend at http://localhost:3000 and interact with the platform!

For any issues, please refer to the documentation or open an issue.


Future Scope

MindSnap aims to continuously evolve with the following potential enhancements:

  • AI-Powered Personalized Learning Paths: Adaptive recommendations and content tailored to individual learning styles and progress.
  • Mobile App Integration: Native apps for iOS and Android to expand accessibility and engagement.
  • Expanded Blockchain Features: NFT-based achievements, decentralized identity, and cross-platform token rewards.
  • Social & Collaborative Learning: Group challenges, peer-to-peer tutoring, and community-driven content creation.
  • Advanced Analytics: Deeper insights for users and educators to track learning outcomes and optimize strategies.

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages