Skip to content

Latest commit

 

History

History
74 lines (52 loc) · 2.97 KB

README.md

File metadata and controls

74 lines (52 loc) · 2.97 KB
Raw

Online Group Study Platform

Explore the live website: Online Group Study Platform

Overview

This platform serves as an online hub dedicated to facilitating group study sessions for students. Built on the MERN stack with various libraries and frameworks, it offers a robust set of features tailored for collaborative learning.

Key Features

  • Public Access: All visitors can view study materials, assignments, and FAQs.
  • User Accounts: Registration and login allow users to manage assignments.
  • Study Session Creation: Logged-in users can create new study sessions with topics, schedule, and materials.
  • Study Session Management: Creators can edit or delete their sessions.
  • Collaborative Tools: Users engage in discussions, share resources, and work collectively on assignments.
  • Assignment Submission: Participants submit assignments and track progress within sessions.
  • Instructor Interaction: Instructors provide feedback, grade assignments, and guide sessions.
  • Responsive Design: Tailwind CSS ensures an intuitive and adaptable interface across devices.

Technologies and Tools Used

Frontend:

  • React: JavaScript library for building user interfaces.
  • Tailwind CSS: Utility-first CSS framework for rapid custom design.
  • Tanstack Query: Remote data management in React.
  • React Icon: Popular icon packs as React components.
  • Material UI: Pre-designed React UI framework.
  • React Helmet: Manage document head changes.
  • Firebase: Backend services for authentication, database, and hosting.
  • Moment.js: Manipulate and display dates and times.
  • React Datepicker: Date picker component for React apps.
  • FARMER-MOTAIN: (Please provide more details if custom or specific)
  • React Router Dom: Routing in React apps.
  • React Hot Toast: Toast notification library for React.

Backend:

  • cookie-parser: Middleware for handling cookies.
  • cors: Cross-Origin Resource Sharing middleware.
  • dotenv: Load environment variables from .env.
  • express: Web framework for Node.js.
  • jsonwebtoken: Generate and verify JSON Web Tokens.
  • mongodb: Official MongoDB driver for Node.js.

Hosting

The website is hosted on Firebase or Vercel.

Installation

  1. Clone the repository: git clone https://github.com/mohiqudraty/study-online-school.git
  2. Install dependencies:
    • For NPM: npm install
    • For Yarn: yarn install
  3. Configure environment variables:
    • Create a .env file in the root directory.
    • Add your MongoDB connection string and other necessary variables.
  4. Start the server:
    • For NPM: npm run dev
    • For Yarn: yarn dev
  5. Open http://localhost:5000 in your browser.

Usage

  1. Register or log in to your account.
  2. Create new study sessions, join existing ones, or engage in discussions.
  3. Submit assignments, collaborate with peers, and track study progress.