🧱 Bricks LMS

Student-Centric Learning Management System for Schools and Coaching Centers

Overview • Key Features • Technology Stack • Getting Started • QuestionBank API • Contribute • Contact

---

🧩 Overview

Bricks LMS is a modern, student-centric Learning Management System designed for schools and coaching centers.
It empowers educators to create engaging learning experiences and gives students interactive tools for effective learning, revision, and performance tracking.

---

🚀 Key Features

👨‍🏫 For Educators

• 🧠 Custom Quiz Creation — Build assessments from an extensive, multi-subject question bank.
• 📊 Performance Analytics — Track student progress with insights and reports.
• ⚙️ Automated Grading — Save time with instant evaluation of student responses.
• 📚 Curriculum Management — Organize content by subjects, topics, and learning objectives.

🎓 For Students

• 🎯 Interactive Learning — Quizzes, challenges, and gamified rewards.
• 🔁 Revision Reels — Quick, bite-sized revision in an engaging reel format.
• 📈 Performance Tracking — Identify weak areas and monitor growth.
• 🧭 Personalized Learning Paths — Adaptive content tailored to each learner.

---

🧱 Technology Stack

Layer	Technologies
Backend	Spring Boot · Java
Frontend	React.js · Material UI
Database	MySQL
Authentication	JWT-based security
Status	🚧 In development...

---

⚡ Getting Started

✅ Prerequisites

Make sure you have these installed:

• Java 17+
• Node.js 16+
• MySQL 8.0+
• Maven

---

🏗️ Installation Steps

1. Clone the Repository

   git clone https://github.com/Vimal290704/Bricks-Ai-LMS

2. Configure Environment Variables Edit your application.properties file inside the backend folder:

   spring.application.name=Bricks-Ai-LMS
   spring.datasource.url=jdbc:mysql://127.0.0.1:3306/bricks_db?createDatabaseIfNotExist=true
   spring.datasource.username=your_username
   spring.datasource.password=your_password
   spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
   spring.jpa.hibernate.ddl-auto=update
   spring.jpa.show-sql=true
   jwt.secret=your_SECRET_KEY

3. Run the Backend

   cd backend
   ./mvnw spring-boot:run

4. Run the Frontend

   cd frontend
   npm install
   npm start

5. Access the App Navigate to 👉 http://localhost:3000

---

🔍 QuestionBank API

The QuestionBank module provides rich filtering capabilities to retrieve questions by multiple criteria.

Supported Filters

• Topic
• Subject
• Difficulty level — EASY, MEDIUM, HARD
• Question type — MCQ, Essay, etc.
• Combined filters for advanced searching

Example Request

GET /api/questions/filter?topicId=1&difficulty=MEDIUM&subjectId=2&type=MCQ

---

🤝 Contribution Guidelines

We welcome contributions! Here’s how you can help improve Bricks LMS:

1. Fork the repository

2. Create a new branch

   git checkout -b feature/amazing-feature

3. Commit your changes

   git commit -m "Add amazing feature"

4. Push to your branch

   git push origin feature/amazing-feature

5. Open a Pull Request

✨ Please ensure your code follows the project’s style guide and includes relevant tests.

---

📬 Contact

For support or collaboration:

• 📧 support@bricks.org.in
• 📧 vimalyadavkr001@gmail.com

---

Made with ❤️ by Bricks
Empowering Education Through Technology