Samarthanam Volunteer Management System

A modern volunteer management platform for Samarthanam Trust, built with React, TypeScript, Vite, and Supabase.

Features

• Admin and volunteer user roles with separate dashboards
• Event management and volunteer registration
• Feedback collection and reporting
• Modern, accessible UI with dark mode support
• Responsive design for all devices

Tech Stack

• Frontend: React, TypeScript, Vite, Tailwind CSS, shadcn/ui
• Backend: Supabase (Auth, Database, Storage)
• ORM: Drizzle ORM for typesafe database access
• API: RESTful API with React Query
• State Management: React Context API + React Query
• Deployment: Docker & GitHub Actions

Getting Started

Prerequisites

• Node.js 18+ and npm/pnpm
• Supabase account (free tier works)

Installation

1. Clone the repository:

   git clone https://github.com/your-username/samarthanam.git
   cd samarthanam

2. Install dependencies:

   pnpm install

3. Copy the .env.example to .env and configure your environment variables:

   cp .env.example .env

4. Update the .env file with your Supabase credentials:

   VITE_SUPABASE_URL=your_supabase_url
   VITE_SUPABASE_ANON_KEY=your_supabase_anon_key
   DATABASE_URL=your_postgresql_connection_string

5. Start the development server:

   pnpm dev

Code Organization

• src/admin/ - Admin dashboard components and pages
• src/components/ - Shared UI components
• src/db/ - Database schema and configuration
• src/lib/ - Utilities and context providers
• src/pages/ - Main application pages
• src/services/ - API and authentication services

Contributing

1. Create a feature branch:

   git checkout -b feature/your-feature-name

2. Make your changes and commit:

   git commit -m "feat: add your feature"

3. Push to the branch:

   git push origin feature/your-feature-name

4. Open a pull request

License

This project is licensed under the MIT License.

Database

The application uses Supabase for database storage and authentication.

Environment Variables

Make sure to set up these environment variables in your .env file:

VITE_SUPABASE_URL=https://your-project.supabase.co
VITE_SUPABASE_ANON_KEY=your-supabase-anon-key

Database Structure

The database contains the following tables:

• admin - Admin user details
• volunteer - Volunteer user details
• event - Event information
• task - Tasks associated with events
• event_signup - Volunteer signups for events
• task_assignment - Task assignments for volunteers
• feedback - Feedback from events
• newsletter - Newsletter subscribers

Accessing Data

The Supabase client is available in the src/lib/supabase.ts file. Example usage:

import { supabase } from '@/lib/supabase';

// Get admin by email
const { data: admin, error } = await supabase
  .from('admin')
  .select('*')
  .eq('email', email)
  .single();

// Create new admin
const { data: newAdmin, error } = await supabase
  .from('admin')
  .insert({
    email: '[email protected]',
    first_name: 'Admin',
    last_name: 'User',
    password: 'securepassword'
  })
  .select()
  .single();

Database Setup

To properly set up the database schema for the Samarthanam Volunteer Management System, follow these steps:

1. Connect to Supabase SQL Editor:

   • Log in to your Supabase dashboard
   • Navigate to the SQL Editor section

2. Run the required scripts in this order:

   # First, run the base schema script to establish the tables
   src/db/fix-database-schema.sql
   
   # Then set up the notification system
   src/db/create-notification-system.sql
   
   # If you need to assign volunteers to tasks programmatically, run
   src/db/assign-volunteer-function.sql

3. Verify the database structure:

   • Each table should have the required columns as defined in the schema
   • Foreign key relationships should be properly established
   • The notification system triggers and functions should be set up

4. Troubleshooting Database Issues:

   If you encounter database-related errors when using the application, they typically fall into one of these categories:

   • Missing Tables: Run the appropriate SQL scripts to create missing tables
   • Missing Columns: Use ALTER TABLE statements to add missing columns
   • Foreign Key Constraints: Ensure that references between tables are properly set up
   • Notification System: Verify that the notification triggers and functions are working

Database Schema Overview

The system uses the following key tables:

• volunteer: Stores volunteer information and profiles
• event: Stores event details and schedules
• event_signup: Tracks volunteer registration for events
• task: Stores task information linked to events
• task_assignment: Tracks task assignments to volunteers
• notification: Stores notifications sent to volunteers and admins

Notification System

The notification system uses several functions:

1. auto_expire_task_assignments(): Automatically expires task assignments past their response deadline
2. send_deadline_reminders(): Sends reminder notifications for tasks with approaching deadlines
3. assign_volunteer_to_task(): Function to assign volunteers to tasks with proper notification