Skip to content

Pabby01/studIQ

Repository files navigation

StudIQ - Smart Campus Learning Platform

StudIQ is a comprehensive learning platform that combines AI-powered education, campus collaboration, and decentralized finance to create an engaging student experience.

Features

🧠 AI Learning Hub

  • Smart Summaries: AI-generated summaries from course materials
  • Quiz Generator: Personalized quizzes based on content
  • Study Insights: Track learning patterns and progress
  • Material Management: Upload and organize study resources

💰 Finance Hub

  • Budget Planner: Create budgets and track expenses
  • Portfolio Tracker: Monitor assets with risk visualization
  • DeFi Learning: Safe guided modules for blockchain education
  • Savings Goals: Set and track financial targets

🎓 Campus Hub

  • Club Management: Create and join campus clubs
  • Event Organization: Schedule and RSVP to events
  • Resource Sharing: Collaborate on study materials
  • Study Groups: Form and manage study sessions

👤 Profile & Goals

  • Progress Tracking: Monitor academic achievements
  • XP System: Earn experience points across activities
  • Badge System: Unlock achievements for engagement
  • Portfolio Builder: Showcase certifications and projects

Technology Stack

  • Frontend: Next.js 13+, TypeScript, Tailwind CSS
  • UI Components: shadcn/ui, Lucide Icons
  • Backend: Supabase (PostgreSQL, Auth, Storage)
  • Authentication: Email/Password, Magic Link
  • Security: Row Level Security (RLS), Least Privilege Access
  • Performance: Server Components, Image/Font Optimization
  • Monitoring: Custom Performance & Error Tracking

Getting Started

Prerequisites

  • Node.js 18+
  • npm or yarn
  • Supabase account

Installation

  1. Clone the repository:
git clone https://github.com/your-username/studiq.git
cd studiq
  1. Install dependencies:
npm install
# or
yarn install
  1. Set up environment variables:
cp .env.example .env.local

Edit .env.local with your Supabase credentials and other configurations.

  1. Run database migrations:
npm run supabase:migrate
# or
yarn supabase:migrate
  1. Start the development server:
npm run dev
# or
yarn dev

The application will be available at http://localhost:3000.

Project Structure

studiq/
├── app/                    # Next.js 13+ app directory
│   ├── api/               # API routes
│   ├── features/          # Feature pages
│   └── ...
├── components/            # React components
│   ├── features/         # Feature-specific components
│   ├── ui/              # Reusable UI components
│   └── ...
├── lib/                   # Utility functions and services
├── public/               # Static assets
└── supabase/            # Database migrations and schemas

Security Features

  • Row Level Security (RLS) policies for all tables
  • Secure authentication flow with email verification
  • Rate limiting on sensitive endpoints
  • Input validation and sanitization
  • Secure file upload with type restrictions
  • Error handling with sanitized messages

Performance Optimizations

  • Server Components for reduced client-side JS
  • Image and font optimization
  • Resource preloading and lazy loading
  • Caching and debouncing implementations
  • Efficient database indexing
  • Package import optimization

Contributing

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Commit changes: git commit -m 'Add amazing feature'
  4. Push to branch: git push origin feature/amazing-feature
  5. Open a Pull Request

License

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

Support

For support, email support@studiq.com or join our Discord community

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published