SBHS Club Portal

Introduction

The SBHS Club Portal is a web application designed to efficiently manage data for over 50 clubs and 3,000+ students at South Brunswick High School. It automates club attendance tracking, centralizes storage for club files, meeting schedules, and announcements, and integrates seamlessly with the school's Google accounts for easy access and management.

Table of Contents

• Features
• Technologies
• Installation
• Configuration

You're right—GitHub README files don’t support inline CSS like border-radius or box-shadow. Instead, here’s an optimized version that works well in GitHub’s Markdown rendering:

---

Features

🌐 Google Account Integration

Seamlessly integrates with school Google accounts for easy access and management:

• Automatic Administrator Privileges: Teachers (@schools.org) can create, manage, and oversee clubs.
• Automatic Student Privileges: Students (@sbstudents.org) can join invited clubs and check in.

🌙 Light & Dark Mode

Choose between light and dark modes for a comfortable user experience.

Dark Mode	Light Mode

📌 Automated Attendance Tracking

Enhances efficiency by verifying attendance through:

• A 4-digit check-in code
• Location proximity or school Wi-Fi connection

Attendance Code	Verification Screen

✅ Administrator Check-in Management

Admins can monitor and validate check-ins efficiently using the same 4-digit code + location/Wi-Fi verification system.

Create Check-ins	Check-in Logs

Here’s the improved version formatted for GitHub’s Markdown:

---

🪪 Consolidated Profile Section

A place to switch modes and log out.

Profile View	Logout Option

📁 Centralized Storage & Communication

A unified platform for club files, meeting schedules, and announcements, ensuring streamlined communication.

Technologies

Installation

1. Clone the Repository:

   git clone https://github.com/vigneshsaravanakumar404/SBHS-Club-Portal.git
   cd SBHS-Club-Portal

2. Install Dependencies: Ensure you have Node.js installed. Then, run:

   npm install

3. Set Up Environment Variables: Create a .env file in the root directory and configure the necessary environment variables, such as database connection strings and Google API credentials.

4. Run Database Migrations: If using Prisma, execute:

   npx prisma migrate deploy

5. Start the Application:

   npm start

Configuration

The application can be customized through various configuration options:

• Database: Configure your database settings in the .env file.
• Google Integration: Set up Google API credentials to enable account integration.