Skip to content

VanishedAIR/BrainHive

Repository files navigation

BrainHive 🐝

Hive Together, Thrive Together.
A platform for students to easily find, join, and manage study groups - Developed for educational purposes

Team:

Repository: GitHub Repo


🚀 Features

  • 🔐 Secure Authentication
    Login/Logout with Clerk & password recovery flow
  • 👥 Study Groups
    • Create/delete groups
    • Advanced search with subject/location
  • 🔄 Real-Time Feed
    Post updates and resources with chronological sorting
  • 📅 Meeting Sync
    Integrate with When2Meet for optimal scheduling
  • 📱 Mobile Support
    Responsive website providing full website support to smaller devices

🔧 Installation & Setup

  1. Clone the repository

    git clone https://github.com/VanishedAIR/BrainHive.git
    cd BrainHive
    
  2. Install dependencies

    npm install
    
  3. Environment Variables Create a .env file in the root directory with:

    DATABASE_URL="your_postgres_database_url"
    CLERK_SECRET_KEY="your_clerk_secret_key"
    NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY="your_clerk_publishable_key"
    
  4. Set up the database

    npx prisma generate
    npx prisma db push
    
  5. Run the development server

    npm run dev
    

🧪 Testing

Run tests with Jest:

npm run test

To run tests in watch mode:

npm run test:watch

⚠️ Academic Disclaimer

This student project was created at California State University - Long Beach for educational purposes. It is not a commercial product and is not intended for production use. Some features may be simplified or incomplete compared to professional applications.

Third-Party Services Notice

This project integrates with external services, including:

  • Clerk (Authentication)
  • Postgresql (Database)
  • Prisma (Data Modeling)
  • Neon (Serverless Postgres Platform)
  • When2Meet (Scheduling)

Each service operates under its terms of use and privacy policy. This project does not claim ownership or responsibility for these third-party services.

About

BrainHive - A Study Group Finder, made for a Univeristy project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 7