Skip to content

Pabby01/StudIQ-Main

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

StudIQ 🎓💰

The AI-Powered Student Financial Platform - Empowering students through intelligent financial literacy, collaborative savings, and AI-driven tutoring.

StudIQ Banner

🌟 Overview

StudIQ is a comprehensive financial platform designed specifically for students, combining cutting-edge AI technology with decentralized finance (DeFi) principles. Our platform helps students learn financial responsibility while providing practical tools for managing their finances on campus.

🚀 Key Features

🤖 AI-Powered Financial Assistant

  • Intelligent Budgeting: AI analyzes spending patterns and provides personalized recommendations
  • Smart Savings Goals: Automated savings strategies tailored to student lifestyles
  • Financial Literacy Tutor: Interactive AI tutoring for financial education
  • Predictive Analytics: Forecast future financial scenarios

💰 Collaborative Savings Pools

  • Risk-Assessed Group Savings: AI-powered risk assessment for pool participation
  • Smart Contribution Matching: Automated matching based on financial profiles
  • Reward System: Earn rewards for consistent saving habits
  • Social Features: Connect with like-minded savers

🛍️ Campus Store Integration

  • Exclusive Student Discounts: Special pricing for verified students
  • Campus Merchant Network: Local business partnerships
  • Cashback Rewards: Earn rewards on campus purchases
  • Digital Wallet Integration: Seamless payment processing

🔐 Secure Wallet Management

  • Multi-Chain Support: Solana and other blockchain networks
  • Privy Integration: Enterprise-grade wallet security
  • Biometric Authentication: Advanced security features
  • Cold Storage Options: Enhanced asset protection

📊 Comprehensive Analytics

  • Real-Time Portfolio Tracking: Live updates on all assets
  • Performance Analytics: Detailed financial insights
  • Goal Progress Tracking: Visual progress toward savings targets
  • Spending Pattern Analysis: AI-driven spending categorization

🛠️ Technology Stack

Frontend

  • Framework: Next.js 15 with App Router
  • Language: TypeScript 5.9+
  • Styling: Tailwind CSS with custom design system
  • UI Components: Radix UI primitives for accessibility
  • State Management: React Context + Custom hooks
  • Charts: Recharts for data visualization

Backend & Infrastructure

  • Authentication: Privy (Web3 + Traditional)
  • Database: Supabase (PostgreSQL with RLS)
  • AI/ML: OpenAI GPT models
  • Caching: Redis + Intelligent in-memory caching
  • File Storage: Supabase Storage
  • APIs: RESTful + WebSocket for real-time updates

Blockchain & Web3

  • Wallet Integration: Privy (Multi-chain support)
  • Primary Chain: Solana for fast, low-cost transactions
  • Smart Contracts: Anchor framework
  • DeFi Protocols: Integrated yield farming and staking

Development & DevOps

  • Testing: Jest + React Testing Library
  • Linting: ESLint with custom rules
  • Build: Next.js optimized builds
  • Deployment: Vercel-ready configuration
  • Monitoring: Custom performance monitoring

📋 Prerequisites

  • Node.js: 18.0.0 or higher
  • Package Manager: npm 9+ or yarn 3+
  • Git: Latest version
  • Environment: Windows, macOS, or Linux

🚀 Quick Start

1. Clone the Repository

git clone https://github.com/Pabby01/StudIQ-main.git
cd StudIQ-main

2. Install Dependencies

npm install
# or
yarn install

3. Environment Configuration

Create a .env.local file in the root directory:

# Required: Privy Configuration
NEXT_PUBLIC_PRIVY_APP_ID=your_privy_app_id
PRIVY_APP_SECRET=your_privy_app_secret

# Required: OpenAI Configuration
OPENAI_API_KEY=your_openai_api_key

# Required: Supabase Configuration
NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
SUPABASE_SERVICE_ROLE_KEY=your_service_role_key

# Optional: Redis Configuration (for production)
REDIS_URL=redis://localhost:6379

# Optional: Additional Configuration
NEXT_PUBLIC_SITE_URL=http://localhost:3000
NODE_ENV=development

4. Database Setup

# Run Supabase migrations (if applicable)
npm run db:migrate

# Seed initial data (optional)
npm run db:seed

5. Start Development Server

npm run dev
# or
yarn dev

6. Open Your Browser

Navigate to http://localhost:3000

📁 Project Structure

StudIQ/
├── src/
│   ├── app/                    # Next.js App Router
│   │   ├── (auth)/            # Authentication pages
│   │   ├── dashboard/         # Main dashboard
│   │   ├── pools/             # Savings pools feature
│   │   ├── stores/            # Campus stores
│   │   ├── ai-tutor/          # AI tutoring interface
│   │   ├── portfolio/         # Portfolio management
│   │   ├── api/               # API routes
│   │   └── layout.tsx         # Root layout with metadata
│   ├── components/            # React components
│   │   ├── ui/               # Base UI components
│   │   ├── auth/             # Authentication components
│   │   ├── dashboard/        # Dashboard components
│   │   └── shared/           # Shared components
│   ├── lib/                   # Utility functions
│   │   ├── cache.ts          # Caching utilities
│   │   ├── security.ts       # Security functions
│   │   ├── websocket.ts      # WebSocket service
│   │   └── validators.ts     # Input validation
│   ├── hooks/                 # Custom React hooks
│   ├── types/                 # TypeScript definitions
│   └── styles/                # Global styles
├── supabase/                  # Database configuration
│   ├── migrations/           # Database migrations
│   ├── seed/                 # Seed data
│   └── performance.sql       # Performance optimizations
├── public/                    # Static assets
│   ├── images/               # Image assets
│   ├── icons/                # Icon files
│   └── favicon.ico           # Website favicon
├── tests/                     # Test files
├── docs/                      # Documentation
└── scripts/                   # Build/deployment scripts

🎯 Available Scripts

Development

npm run dev          # Start development server
npm run build        # Build for production
npm run start        # Start production server
npm run lint         # Run ESLint

Testing

npm run test         # Run all tests
npm run test:watch   # Run tests in watch mode
npm run test:coverage # Generate coverage report

Database

npm run db:migrate   # Run database migrations
npm run db:seed      # Seed database with sample data
npm run db:reset     # Reset database

Code Quality

npm run lint         # Run ESLint
npm run lint:fix     # Fix ESLint issues
npm run type-check   # Run TypeScript checks
npm run format       # Format code with Prettier

🔧 Configuration Guide

Wallet Integration (Privy)

  1. Create account at Privy.io
  2. Create new application
  3. Configure authentication methods (Web3 + Email/Social)
  4. Add allowed domains
  5. Copy App ID and Secret to environment variables

AI Features (OpenAI)

  1. Create OpenAI account
  2. Generate API key
  3. Configure usage limits
  4. Set up billing (for production)
  5. Monitor usage dashboard

Database (Supabase)

  1. Create Supabase project
  2. Set up database schema
  3. Configure RLS policies
  4. Set up authentication
  5. Configure storage buckets

Deployment (Vercel)

  1. Connect GitHub repository
  2. Configure environment variables
  3. Set up custom domain
  4. Configure build settings
  5. Enable analytics

🛡️ Security Features

Authentication & Authorization

  • Multi-factor authentication
  • Role-based access control (RBAC)
  • Row Level Security (RLS) policies
  • Session management
  • Rate limiting

Data Protection

  • End-to-end encryption
  • Secure API endpoints
  • Input validation & sanitization
  • SQL injection prevention
  • XSS protection

Financial Security

  • Smart contract audits
  • Multi-signature wallets
  • Cold storage integration
  • Transaction monitoring
  • Fraud detection

📊 Performance Optimizations

Caching Strategy

  • Redis: Distributed caching for API responses
  • Intelligent Cache: In-memory caching with TTL
  • Browser Caching: Optimized static asset delivery
  • CDN: Global content delivery network

Database Optimization

  • Indexes: Comprehensive indexing strategy
  • Query Optimization: Optimized SQL queries
  • Connection Pooling: Efficient database connections
  • Read Replicas: Scale read operations

Frontend Performance

  • Code Splitting: Lazy loading for optimal bundles
  • Image Optimization: Next.js Image component
  • Font Optimization: Custom font loading
  • Bundle Analysis: Webpack bundle analyzer

🧪 Testing Strategy

Unit Tests

  • Component testing with React Testing Library
  • Utility function testing
  • API route testing
  • Custom hook testing

Integration Tests

  • Database integration tests
  • API integration tests
  • Authentication flow tests
  • Payment processing tests

End-to-End Tests

  • User journey testing
  • Critical path testing
  • Cross-browser testing
  • Mobile responsiveness testing

📈 Monitoring & Analytics

Application Performance

  • Custom performance monitoring
  • Error tracking and reporting
  • User behavior analytics
  • A/B testing framework

Financial Analytics

  • Transaction monitoring
  • Risk assessment metrics
  • User engagement analytics
  • Revenue tracking

Infrastructure Monitoring

  • Server health monitoring
  • Database performance monitoring
  • API response time tracking
  • Error rate monitoring

🤝 Contributing

We welcome contributions from the community! Please see our Contributing Guide for details.

Quick Contribution Steps

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests (npm run test)
  5. Commit your changes (git commit -m 'Add amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

📝 License

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

🙏 Acknowledgments

  • Privy for secure wallet infrastructure
  • OpenAI for AI capabilities
  • Supabase for database infrastructure
  • Vercel for hosting and deployment
  • Solana for blockchain infrastructure

📞 Support

For support, please:


Made with ❤️ for students everywhere

StudIQ - Because financial literacy should be intelligent, collaborative, and accessible to all students.

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published