Skip to content

Compete with friends, join study groups, and track your progress to become a top student.

Notifications You must be signed in to change notification settings

AmanVarshney01/topstudz

Repository files navigation

TopStudz

TopStudz is a modern student study management platform designed to help students track, optimize, and improve their study habits. With features like study session tracking, group collaboration, and performance analytics, TopStudz makes studying more effective and engaging.

Features

  • 🕒 Study Timer

    • Customizable Pomodoro-style study sessions
    • Session tracking and statistics
  • 📈 Performance Analytics

    • Visual progress tracking
    • Monthly study hour analysis
    • Performance trends and insights
  • 👥 Study Groups

    • Create and join study groups
    • Group chat functionality
    • Collaborative study sessions
  • 🏆 Leaderboards

    • Global study time rankings
    • Group-specific leaderboards
    • Personal progress tracking
  • 🤖 AI Study Assistant

    • Personalized study advice
    • Context-aware recommendations
    • Real-time study habit analysis
    • Interactive chat interface
    • Study technique suggestions based on performance

Tech Stack

Frontend

  • Next.js 15 - React framework with App Router
  • TypeScript - Typed JavaScript
  • TailwindCSS - Utility-first CSS framework
  • Shadcn/ui - Re-usable component system

Backend

  • Convex - Backend application platform with real-time capabilities
  • Google Gemini - Advanced AI model for study assistance

Getting Started

Prerequisites

  • Node.js 18+
  • Convex account
  • GitHub account (for authentication)

Installation

  1. Clone the repository
gh repo clone amanvarshney01/topstudz
cd topstudz
  1. Install dependencies
bun i
  1. Start the development server
bun run dev

Note: Running bun run dev will automatically set up and initialize Convex for you. You'll be prompted to log in to your Convex account if you haven't already.

Project Structure

topstudz/
├── app/                    # Next.js app directory
│   ├── (protected)/       # Protected routes (dashboard, groups, etc.)
│   │   └── dashboard/
│   ├── api/              # API routes
│   │   └── ai-helper/   # AI assistant endpoint
│   └── signin/           # Authentication page
├── components/            # Reusable UI components
│   ├── ui/               # Base UI components (shadcn)
│   └── ...               # Feature-specific components
├── convex/               # Backend functions and schema
│   ├── _generated/      # Generated Convex types
│   ├── schema.ts        # Database schema
│   └── ...              # Backend functions
├── hooks/               # Custom React hooks
├── lib/                 # Utility functions and shared logic
└── public/             # Static assets and favicons

Acknowledgments

Roadmap

  • AI-powered study recommendations
  • PWA support
  • Onboarding
  • Gamification and rewards system
  • Advanced analytics and insights

About

Compete with friends, join study groups, and track your progress to become a top student.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published