Feat/mentoring system

.firebaserc

@@ -0,0 +1,5 @@
+{
+  "projects": {
+    "default": "garuda-hacks-6-0"
+  }
+}

.gitignore

@@ -39,3 +39,7 @@ yarn-error.log*
 # typescript
 *.tsbuildinfo
 next-env.d.ts
+
+# for dev only - Ryan
+/app/api/create-mentors/**
+*adminsdk*.*

README.md

@@ -1,36 +1,138 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+# Garuda Hacks Admin Portal 🚀
 
-## Getting Started
+The official admin portal for Garuda Hacks 6.0, a premier hackathon event. Built with modern web technologies to provide a seamless experience for administrators.
 
-First, run the development server:
+## 🛠️ Tech Stack
+
+- **Frontend**
+
+  - Next.js 15
+  - React 19
+  - TypeScript
+  - TailwindCSS
+  - Vercel Analytics
+
+- **Backend**
+
+  - Firebase Cloud Functions
+  - Firebase Authentication
+  - Firebase Firestore
+
+- **Deployment**
+  - Vercel
+  - Vercel Analytics
+
+## 🚀 Getting Started
+
+### Prerequisites
+
+- Node.js (v18 or higher)
+- npm or yarn
+- Firebase account
+
+### Installation
+
+1. Clone the repository
+
+```bash
+git clone https://github.com/your-username/gh-admin.git
+cd gh-admin
+```
+
+2. Install dependencies
+
+```bash
+npm install
+```
+
+3. Set up environment variables
+
+```bash
+cp .env.example .env
+```
+
+Fill in your Firebase configuration in `.env`
+
+4. Start development server
 
 ```bash
 npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+### Building for Production
+
+```bash
+npm run build
+```
+
+## 📁 Project Structure
+
+```
+gh-admin/
+├── app/                # Next.js app directory
+├── components/         # Reusable UI components
+├── contexts/           # React context providers
+├── lib/                # Utility functions and Firebase config
+├── public/             # Static assets
+├── static/             # Additional static files
+├── .github/            # GitHub workflows and templates
+├── firebase.json       # Firebase configuration
+├── next.config.ts      # Next.js configuration
+└── tailwind.config.ts  # Tailwind CSS configuration
+```
+
+## 🔧 Configuration
+
+### Environment Variables
+
+Required environment variables:
+
+- `NEXT_PUBLIC_FIREBASE_API_KEY`
+- `NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN`
+- `NEXT_PUBLIC_FIREBASE_PROJECT_ID`
+- `NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET`
+- `NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID`
+- `NEXT_PUBLIC_FIREBASE_APP_ID`
+- `NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID`
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feat/amazing-feature`)
+3. Make your changes following our commit conventions:
+
+   ```bash
+   # Format
+   <type>(<scope>): <description>
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+   # Examples
+   feat(auth): add Google OAuth login
+   fix(api): resolve proxy configuration
+   docs(readme): update installation steps
+   style(ui): improve button hover states
+   refactor(forms): simplify validation logic
+   test(api): add auth endpoint tests
+   chore(deps): update dependencies
+   ```
 
-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.
+   Types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`
+   Scope: optional, indicates the module affected
 
-## Learn More
+4. Push to the branch (`git push origin feat/amazing-feature`)
+5. Open a Pull Request
 
-To learn more about Next.js, take a look at the following resources:
+## 📝 License
 
-- [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.
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+## 🙏 Acknowledgments
 
-## Deploy on Vercel
+- [Next.js](https://nextjs.org/)
+- [React](https://reactjs.org/)
+- [Firebase](https://firebase.google.com/)
+- [TailwindCSS](https://tailwindcss.com/)
+- [Vercel](https://vercel.com/)
 
-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.
+---
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+Made with ❤️ by the Garuda Hacks Team