Volunteer Portal Documentation
Welcome to the Everybody Eats Volunteer Portal documentation. This comprehensive guide provides everything you need to effectively manage volunteers, shifts, and restaurant operations.
Documentation Sections
Section titled “Documentation Sections”Admin Guide
Section titled “Admin Guide”The core documentation for system administrators who manage the volunteer portal on a daily basis.
- Getting Started - Overview of the admin dashboard and key features
- User Roles & Permissions - Understanding different user types and their access levels
- User Management - Managing volunteer profiles, notes, and permissions
- Shift Management - Creating and managing volunteer shifts
- Troubleshooting - Solutions to common problems
Restaurant Managers
Section titled “Restaurant Managers”Documentation for restaurant managers who oversee multiple locations and need advanced features.
- Multi-Location Features - Managing volunteers across multiple restaurant locations
- Creating Shifts - Setting up volunteer shifts for your location
- Group Bookings - Managing group volunteer bookings
- Reports & Analytics - Understanding your volunteer metrics
Developer Reference
Section titled “Developer Reference”Technical documentation for developers working on the volunteer portal system.
- Technology Stack - Overview of the technologies and frameworks used
- Hosting & Infrastructure - Production hosting, deployment, and third-party services
- Authentication - Understanding the authentication system
- OAuth Setup - Configuring OAuth providers
Quick Links
Section titled “Quick Links”For Admins
Section titled “For Admins”For Restaurant Managers
Section titled “For Restaurant Managers”For Developers
Section titled “For Developers”Getting Help
Section titled “Getting Help”If you need assistance with the volunteer portal:
- Check the Troubleshooting section for common issues
- Review the User Problems guide for volunteer-specific issues
- Contact your system administrator for technical support
- For developers: Check the GitHub repository
System Overview
Section titled “System Overview”The Everybody Eats Volunteer Portal is a comprehensive system designed to:
- Streamline volunteer management with profile tracking and emergency contacts
- Simplify shift scheduling with an intuitive calendar interface
- Enable group bookings for volunteers who want to sign up together
- Track volunteer engagement with achievements and milestones
- Support multiple locations with location-specific features
- Ensure safety compliance with parental consent tracking for minors
The system uses modern web technologies including Next.js, TypeScript, and PostgreSQL, hosted on Vercel with Supabase for database services.
Select a section from the sidebar to begin exploring the documentation.