Merge pull request #7 from PinsaraPerera/dev

Dev

Author: PinsaraPerera

README.md

@@ -1,36 +1,114 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# Vivent Event Management System
+
+A comprehensive event management system for tracking attendance, managing participants, and sending personalized email campaigns for workshops and events.
+
+## Features
+
+- **Student Management**: Add, edit, and delete student records with unique ticket IDs
+- **Workshop Organization**: Manage multiple workshops with separate student collections
+- **Attendance Tracking**: Mark and track attendance for each event
+- **Bulk Import**: Upload CSV files to add multiple students at once
+- **Email Campaigns**: Send personalized emails to selected participants
+- **Batch Processing**: Send emails in batches of 10 to avoid rate limits
+- **Dashboard Analytics**: View attendance statistics and event metrics
+- **Modern UI**: Clean, responsive interface with real-time notifications
+
+## Screenshots
+
+### Login
+![Login Screenshot](./resources/login.png)
+
+### Dashboard
+![Dashboard Screenshot](./resources/dashboard.png)
+
+### Attendance Tracking
+![Attendance Tracking Screenshot](./resources/participant_management.png)
+
+### Email Campaigns
+![Email Campaigns Screenshot](./resources/email_campaign.png)
+
+### Workshop Management
+![Workshop Management Screenshot](./resources/new_event.png)
+
+### Email Logs
+![Email Logs Screenshot](./resources/email_logs.png)
+
+### Template Selection
+![Template Screenshot](./resources/templates.png)
+
+## Technology Stack
+
+- **Frontend**: Next.js 15 with React 19
+- **UI Framework**: Tailwind CSS
+- **State Management**: Redux with Redux Persist
+- **Database**: Supabase PostgreSQL
+- **Authentication**: JWT-based authentication
+- **Email Service**: Mailjet API integration
+- **Deployment**: Cloud Run (frontend) / Supabase (DB)/ Cloud Run (backend)
 
 ## Getting Started
 
-First, run the development server:
+### Prerequisites
+
+- Node.js 18.0 or higher
+- Supabase account
+- Mailjet API credentials
+
+### Installation
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/PinsaraPerera/Vivent.git
+   cd Vivent
+   ```
+
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
+
+3. Create a `.env.local` file with the following variables:
+   ```
+   NEXT_BACKEND_URL=add_your_backend_base_url
+   ```
+
+4. Run the development server:
+   ```bash
+   npm run dev
+   ```
+
+5. Open [http://localhost:3000](http://localhost:3000) in your browser
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+## Usage
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+### Managing Students
 
-You can start editing the page by modifying `app/page.js`. The page auto-updates as you edit the file.
+- Add students individually or import in bulk via CSV
+- Each student is assigned a unique ticket ID
+- Filter and search students by name or email
+- Mark attendance with a simple toggle
 
-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+### Email Campaigns
 
-## Learn More
+1. Select a workshop to load its participants
+2. Choose an email template
+3. Select recipients individually or use "Select All"
+4. Preview the email before sending
+5. Send emails in batches of 10 for optimal delivery
 
-To learn more about Next.js, take a look at the following resources:
+### Monitoring
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+- Track email campaign progress in real-time
+- View detailed logs of email sending status
+- Monitor attendance rates across workshops
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+## Future Plans
 
-## Deploy on Vercel
+- Advanced analytics and reporting features
+- Mobile app for on-site attendance marking
+- QR code generation for contactless check-in
+- Real-time collaboration features
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+## License
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+This project is licensed under the MIT License - see the LICENSE file for details.