Skip to content

Latest commit

 

History

History
169 lines (106 loc) · 4.7 KB

README.md

File metadata and controls

169 lines (106 loc) · 4.7 KB

Shiksha Mitra

Folder structure:

gamified-lms/
│
├── backend/
│   ├── app/
│   │   ├── __init__.py
│   │   ├── models.py
│   │   ├── views.py
│   │   └── ...
│   ├── migrations/
│   ├── config.py
│   ├── manage.py
│   └── requirements.txt
│
├── frontend/
│   ├── public/
│   ├── src/
│   │   ├── components/
│   │   ├── styles/
│   │   └── App.js
│   └── package.json
│
├── docs/
│   └── README.md
│
└── .env

Introduction

Shiksha Mitra is an innovative MVP designed to reshape the way students learn through gamification. Our platform transforms the traditional approach to education by making learning engaging, interactive, and rewarding. As an MVP, Shiksha Mitra focuses on delivering core features that showcase the value of gamified learning,

Problem Statement

Traditional learning platforms often fail to keep students engaged, leading to decreased participation and lower learning outcomes. Our goal is to create a Gamified LMS that motivates students by introducing game-like elements into their educational journey.

What We Expect

We aim to develop an engaging LMS that promotes active participation through gamification techniques. By rewarding achievements, tracking progress, and providing an interactive learning environment, this platform helps students stay motivated and committed to their educational goals.

Solution Guidelines

The LMS will include the following key features:

  • Achievements and Badges: Students will earn badges for completing milestones, such as finishing a course or scoring well on quizzes.
  • Leaderboards: Students can compete with their peers by earning points and climbing the leaderboard, creating healthy competition.
  • Progress Tracking: Visual feedback on course progress allows students to track their journey and stay on course.
  • Interactive Courses: Teachers and admins can create quizzes, lessons, and modules with real-time feedback, which helps students adjust their learning strategies.

Features

  1. Gamified Learning System:

    • Badges and achievements for completing tasks.
    • Leaderboards showcasing top performers.
    • Progress bars indicating course/module completion.
  2. Admin Dashboard:

    • Create courses, quizzes, and assignments.
    • Track overall student progress and issue rewards.
  3. Student Dashboard:

    • View enrolled courses and track progress.
    • Check achievements and earned badges.
    • Compete with others on the leaderboard.
  4. Real-Time Analytics:

    • Analytics tracking for performance and engagement.
    • Detailed student activity reports.

Tech Stack

  • Backend: Python (Flask)

  • Frontend: HTML, CSS (Bootstrap), JavaScript

  • Database: PostgreSQL/MySQL

  • Authentication: Firebase Authentication or OAuth

  • Gamification Libraries: Custom or BadgeOS

  • Real-time Features: WebSockets (for real-time leaderboard updates)


Installation

Prerequisites

  • Python 3.x
  • PostgreSQL/MySQL

Steps

  1. Clone the repository:

    git clone https://github.com/your-username/gamified-lms.git
    cd gamified-lms
  2. Set Up Environment:

python3 -m venv venv

source venv/bin/activate   

On Windows, use `venv\Scripts\activate`

pip install -r requirements.txt

  1. Set up the database:

Create a new PostgreSQL/MySQL database. Update the database URL in the .env file.

MVP (Minimum Viable Product) Roadmap:

1.)User Authentication: Implement sign-up, login, and access control for students and admins.

2.) Course Creation: Allow admins to create courses, quizzes, and learning modules.

3.) Gamification: Implement badge rewards and a leaderboard to encourage competition.

4.) Analytics Dashboard: Provide real-time analytics to track progress and engagement.

5.) Responsive UI: Ensure the platform is mobile-friendly for students to access on any device.

5.) Future Enhancements:

1.) Social Learning Features: Add chatrooms or discussion forums to promote collaborative learning.

2.) Custom Badges: Allow instructors to design their own badges or import badges from third-party systems.

3.) AI-Powered Learning Suggestions: Use AI to recommend courses based on students’ past performance and preferences.

License:

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

Contributing:

We welcome contributions! Please fork this repository, create a feature branch, and submit a pull request. Ensure your code follows the contribution guidelines.