Skip to content

coderanirban/mindful-learning

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🧠 Mindful Learning Gamified Platform 🚀

Level up your learning experience! Welcome to the Mindful Learning Gamified Platform, a groundbreaking platform where education meets mindfulness and mental well-being. With this gamified approach, we make learning an exciting adventure! 🌟

📖 Overview

In a world where education and mental health are often treated separately, Mindful Learning Gamified Platform integrates them into one seamless experience. This platform provides quests, challenges, and mindful exercises to not only sharpen your skills but also ensure your mental well-being. With our interactive dashboard, mood tracker, and mindfulness exercises, we offer a unique approach to learning that's both fun and rewarding! 💡

Key Features

  • 🎮 Gamified Quests: Complete challenges, earn points, and level up as you progress through learning modules.
  • 🧘‍♀️ Mindfulness Tools: Track your mood and participate in mindful exercises for holistic learning.
  • 🏆 Leaderboard: Compete with your peers and see who’s leading the quest for knowledge!
  • 🌟 Responsive Design: Seamless experience across all devices, from mobile to desktop.
  • 🔒 Protected Routes: Only logged-in users can access the core features, keeping your progress safe and secure.

⚙️ Tech Stack

We used the latest technologies to build this high-performance platform:

  • Frontend: React.js, Material-UI (for a sleek and modern UI)
  • Backend: Node.js, Express (for robust and scalable API handling)
  • Database: MongoDB, PostgreSQL (handling user data and content with efficiency)
  • Authentication: JWT (JSON Web Tokens) for secure login and session management
  • Deployment: Netlify or Vercel for frontend hosting, with AWS for backend services
  • Face Recognition: Integration with face-api.js for potential biometric tracking features

🚀 Getting Started

Follow these simple steps to get the platform up and running locally:

1. Clone the Repository

git clone https://github.com/coderanirban/mindful-learning.git
cd mindful-learning

2. Install Dependencies

npm install

3. Run the App

Start the development server:

npm start

Open http://localhost:3000 in your browser to see the platform in action.

4. Build for Production

To create a production build:

npm run build

🏗️ Folder Structure

Here's a quick breakdown of the project's folder structure:

├── /public               # Static assets (HTML, images, etc.)
├── /src                  # Core application files
│   ├── /components       # React components (Navbar, Dashboard, etc.)
│   ├── /pages            # Main pages (Quests, Mood Tracker, Leaderboard)
│   ├── /utils            # Utility functions (APIs, hooks, etc.)
│   └── App.js            # Main application file
├── /backend              # Backend API with Node.js and Express
│   ├── /models           # MongoDB models
│   ├── /routes           # API routes
│   └── server.js         # Main server file
├── package.json          # NPM scripts and dependencies
└── README.md             # Project documentation

🌟 Features Breakdown

1. Interactive Dashboard

The dashboard presents your current level, earned points, and quest completion status. It’s your control center for tracking progress!

2. Gamified Quests

Quests challenge you to complete various learning tasks. Each completed quest earns you points and levels you up. 🏅

3. Mood Tracker

Track your mood and overall well-being on a daily basis. Use this feature to reflect on your learning journey and mental health.

4. Mindfulness Exercises

Engage in short mindfulness exercises designed to relieve stress and help you stay focused during learning sessions.

5. Leaderboard

Compete against your peers and rise to the top! Whether it's earning points for completing quests or engaging with mindfulness activities, stay motivated with friendly competition.


🎯 Planned Features

  • Social Learning: Connect with peers, share progress, and participate in group challenges.
  • Achievements & Badges: Unlock badges as you hit milestones and complete special quests.
  • AI-driven Recommendations: Get personalized quest recommendations based on your mood and progress.
  • Live Virtual Counseling: Integrated live chat for counseling sessions with experts.

🤝 Contributing

We welcome contributions to enhance the platform and make learning more fun and mindful! Here's how you can get involved:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature-branch)
  3. Commit your changes (git commit -m "Add a cool feature")
  4. Push to the branch (git push origin feature-branch)
  5. Open a Pull Request

🔐 License

This project is licensed under the MIT License - see the LICENSE file for details.


💬 Get in Touch

Have questions or want to collaborate? Reach out to us:


Star this repo if you think this project has potential and you want to stay updated with future features!


Mindful Learning – Making education an adventure for your mind, body, and soul! 💪

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published