CampusConnect

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #llm #go #golang #android #deep-learning #nodejs #java #cli #awesome-list #security

(★ 19)

No description available.

CampusConnect Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# CampusConnect: Every club. Every event. One brutally simple OS.

**🗣️ Join our Discord Server for all contributors:** [https://discord.gg/BEMjApACe](https://discord.gg/BEMjApACe)

![License](https://img.shields.io/github/license/krushit1307/CampusConnect?style=flat-square)
![Open Issues](https://img.shields.io/github/issues/krushit1307/CampusConnect?style=flat-square)
![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)
![Stars](https://img.shields.io/github/stars/krushit1307/CampusConnect?style=flat-square)
![ECSoC 2026](https://img.shields.io/badge/ECSoC-2026-blueviolet?style=flat-square)

CampusConnect solves the chaos of college clubs juggling WhatsApp groups, spreadsheets, and paper certificates. It provides a single, unified platform for students and organizers to manage events, track memberships, and engage with their campus community seamlessly.

[Watch CampusConnect Demo](https://www.youtube.com/watch?v=dQw4w9WgXcQ)

## ✨ Features

- **Event Management:** Create, manage, and promote campus events.
- **RSVP + QR Check-in:** Seamless registration and fast, verifiable QR code check-ins.
- **Club Directory:** Discover and join various campus clubs in one centralized place.
- **Discussion Feed:** Engage with the community through club-specific discussion boards.
- **Certificate Generation:** Automatically generate and distribute event certificates.
- **Realtime Updates:** Instant notifications and live updates powered by Supabase Realtime.

## 🛠️ Tech Stack

## 🗄️ Architecture / Database

CampusConnect stores its data in Supabase (Postgres) and uses Supabase Auth plus Row Level Security to protect access. The schema is defined in [supabase/schema.sql](./supabase/schema.sql) and centers on clubs, the members and events they run, and the posts their members write.

### Entity-relationship diagram

```mermaid
erDiagram
  PROFILES ||--o{ CLUBS : "creates"
  PROFILES ||--o{ CLUB_MEMBERS : "joins as"
  CLUBS ||--o{ CLUB_MEMBERS : "has"
  CLUBS ||--o{ EVENTS : "hosts"
  CLUBS ||--o{ POSTS : "has"
  PROFILES ||--o{ EVENTS : "creates"
  EVENTS ||--o{ EVENT_RSVPS : "receives"
  PROFILES ||--o{ EVENT_RSVPS : "makes"
  PROFILES ||--o{ POSTS : "authors"
  POSTS ||--o{ COMMENTS : "has"
  PROFILES ||--o{ COMMENTS : "authors"
  EVENTS ||--o{ CERTIFICATES : "issues"
  PROFILES ||--o{ CERTIFICATES : "receives"

PROFILES {
    uuid id PK
    text full_name
    text avatar_url
    text college
    text bio
    enum role "student | club_admin"
  }
  CLUBS {
    uuid id PK
    text name
    text slug UK
    text description
    uuid created_by FK
  }
  CLUB_MEMBERS {
    uuid id PK
    uuid club_id FK
    uuid user_id FK
    enum role "member | admin"
    enum status "pending | approved"
  }
  EVENTS {
    uuid id PK
    uuid club_id FK
    text title
    text description
    timestamptz event_date
    uuid created_by FK
  }
  EVENT_RSVPS {
    uuid id PK
    uuid event_id FK
    uuid user_id FK
    bool checked_in
  }
  POSTS {
    uuid id PK
    uuid club_id FK
    uuid author_id FK
    text content
  }
  COMMENTS {
    uuid id PK
    uuid post_id FK
    uuid author_id FK
    text content
  }
  CERTIFICATES {
    uuid id PK
    uuid event_id FK
    uuid user_id FK
    text certificate_url
  }
```

### Core tables

| Table          | Key columns                                                                                                       | Purpose                                                                                                                             |
| :------------- | :---------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------- |
| `profiles`     | `id` (PK, = `auth.users.id`), `full_name`, `avatar_url`, `college`, `bio`, `role`                                 | One row per authenticated user; auto-created by the `on_auth_user_created` trigger on signup.                                       |
| `clubs`        | `id` (PK), `name`, `slug` (unique), `description`, `banner_url`, `logo_url`, `created_by` → `profiles.id`         | A campus club/society. `slug` is used for the public `/clubs/:slug` route.                                                          |
| `club_members` | `id` (PK), `club_id` → `clubs.id`, `user_id` → `profiles.id`, `role`, `status`                                    | Join table linking users to clubs, with a `member`/`admin` role and a `pending`/`approved` status. Unique per `(club_id, user_id)`. |
| `events`       | `id` (PK), `club_id` → `clubs.id`, `title`, `description`, `event_date`, `location`, `created_by` → `profiles.id` | An event hosted by a club.                                                                                                          |
| `event_rsvps`  | `id` (PK), `event_id` → `events.id`, `user_id` → `profiles.id`, `checked_in`                                      | A user's RSVP to an event, plus a `checked_in` flag set on QR check-in. Unique per `(event_id, user_id)`.                           |
| `posts`        | `id` (PK), `club_id` → `clubs.id`, `author_id` → `profiles.id`, `content`                                         | A discussion post on a club's feed.                                                                                                 |
| `comments`     | `id` (PK), `post_id` → `posts.id`, `author_id` → `profiles.id`, `content`                                         | A reply to a post.                                                                                                                  |
| `certificates` | `id` (PK), `event_id` → `events.id`, `user_id` → `profiles.id`, `certificate_url`                                 | A generated certificate issued to a user for attending an event.                                                                    |

### Notes

- All tables have Row Level Security enabled; the policies in [supabase/schema.sql](./supabase/schema.sql) define exactly who can read and write data.
- `posts`, `comments`, and `event_rsvps` are included in the `supabase_realtime` publication to power live-updating feed and RSVP behavior.
- Storage buckets such as `avatars`, `club-banners`, `event-banners`, and `certificates` are public-read, with writes restricted to the authenticated user's own folder.

## 🚀 Getting Started

1. **Clone the repository:**
   ```bash
   git clone [https://github.com/krushit1307/CampusConnect.git](https://github.com/krushit1307/CampusConnect.git)
   cd CampusConnect
   ```
2. **Install dependencies:**
   ```bash
   npm install
   ```
3. **Set up database & environment variables:**
   Choose one of the following two options to run your database:
   - **Option A: Remote Supabase (Default)**
     1. Copy `.env.example` to `.env.local`:
        ```bash
        cp .env.example .env.local
        ```
     2. Fill in your remote hosted Supabase URL and Anon Key.
        Required Environment Variables

The `.env.example` file contains all the required environment variables for running the project.

| Variable                    | Description                                                                                   |
| --------------------------- | --------------------------------------------------------------------------------------------- |
| `VITE_SUPABASE_URL`         | Your Supabase project URL. You can find it in your Supabase project under **Settings → API**. |
| `VITE_SUPABASE_ANON_KEY`    | Your Supabase anonymous (public) API key, available under **Settings → API**.                 |
| `SUPABASE_SERVICE_ROLE_KEY` | Your Supabase service role key. Keep this value private and never commit it to Git.           |

Open `.env.local` and replace the placeholder values with your own Supabase project credentials.

**Important:** Do not commit your `.env.local` file. Only `.env.example` should be tracked in Git. 3. Apply database migrations to your remote project:
`bash
        supabase db push
        `

- **Option B: Local Supabase Container (Recommended for offline development)**
  Follow the [Supabase Local Development & Seeding](#️-supabase-local-development--seeding) guide below to spin up a local container stack pre-populated with test records.

4. **Start the development server:**
   ```bash
   npm run dev
   ```

### 🐳 Running with Docker

For local development and production builds using Docker, please refer to our [Docker Setup Guide](docs/DOCKER_SETUP.md).

### 🗄️ Supabase Local Development & Seeding

Instead of connecting to a remote Supabase instance, you can spin up the full Supabase database stack locally using Docker. This avoids API rate limits and populates your workspace with pre-seeded test data (users, events, clubs, posts, comments).

1. **Start the local Supabase container stack:**

```bash
   supabase start
   ```

_Note: This command requires Docker to be running on your system._

2. **Copy the credentials to `.env.local`:**
   After the database starts successfully, the CLI will output your local API credentials. Copy these keys and update your `.env.local` file:
   - `VITE_SUPABASE_URL`: Set to `http://127.0.0.1:54321`
   - `VITE_SUPABASE_ANON_KEY`: Paste the `anon key` printed by the CLI
   - `SUPABASE_SERVICE_ROLE_KEY`: Paste the `service_role key` printed by the CLI

3. **Reset and seed the database:**
   To apply the initial schema and automatically seed the database with test data:

```bash
   supabase db reset
   ```

This will completely provision your local database. You can log in using:
   - **Admin Account**: `admin@campusconnect.com` / `password123`
   - **Student Account**: `student@campusconnect.com` / `password123`

4. **Access Supabase Studio:**
   You can view and manage your local database tables by opening the local Supabase Studio dashboard in your browser at `http://127.0.0.1:54323/`.

## 📁 Project Structure

- `src/` — Contains all frontend React components, pages, hooks, and utilities.
- `supabase/` — Database migrations, seed data, and Edge Functions.
- `public/` — Static assets like images and fonts.

## 🤝 Contributing

We welcome contributions! Please see our [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to get started. This is an **ECSoC 2026** project, so we are actively looking for contributors. Check out issues labeled `good first issue` to begin!

> [!NOTE]
> **Automated Assignments**: We use a bot to manage issue assignments. Simply comment `/claim` on an issue to assign it to yourself. You have a **30-hour** window to submit a Pull Request before the issue is automatically unassigned.

> [!IMPORTANT]
> **Code Formatting**: Before committing and pushing your code, you **MUST** run `npm run lint` locally. This will automatically format your files and prevent our CI (GitHub Actions) from failing due to Prettier or ESLint errors. Pull Requests with failing CI checks will not be merged.

## 🗺️ Roadmap

- **Phase 1:** Core web platform ✅
- **Phase 2:** Contributor feature build (In Progress)
- **Phase 3:** AI layer (Q4 2026) — AI event recommender, AI post summarizer, RAG chatbot via pgvector

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.

## 👤 Maintainer

**Krushit Prajapati** - [GitHub Profile](https://github.com/krushit1307)

## 👥 Contributors

feat/wasm-image-compression

### 🏆 Hall of Fame (Top 5)

| Rank | Contributor | Contributions |
| :--: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------: |
| 🥇 | <a href="https://github.com/krushit1307"><img src="https://avatars.githubusercontent.com/u/196679210?v=4" width="50" height="50" style="border-radius:50%;"/> krushit1307</a> | 159 |
| 🥈 | <a href="https://github.com/Aryanbuha890"><img src="https://avatars.githubusercontent.com/u/273169945?v=4" width="50" height="50" style="border-radius:50%;"/> Aryanbuha890</a> | 37 |
| 🥉 | <a href="https://github.com/Jivan-Patel"><img src="https://avatars.githubusercontent.com/u/225341922?v=4" width="50" height="50" style="border-radius:50%;"/> Jivan-Patel</a> | 32 |
| 4️⃣ | <a href="https://github.com/MILAN-123865"><img src="https://avatars.githubusercontent.com/u/196552402?v=4" width="50" height="50" style="border-radius:50%;"/> MILAN-123865</a> | 30 |
| 5️⃣ | <a href="https://github.com/Ayush-0918"><img src="https://avatars.githubusercontent.com/u/184804819?v=4" width="50" height="50" style="border-radius:50%;"/> Ayush-0918</a> | 30 |

### 👥 All Contributors

### Design Assets

- [CampusConnect Onboarding Flow Wireframe (Figma)](https://www.figma.com/design/z0rOY6FzRLLfApy81vGNpm/Untitled?node-id=0-1&t=eEgiAEO0pnhJcMvg-1)

CampusConnect

CampusConnect Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

CampusConnect

CampusConnect Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README