Skip to content

README.md

Latest commit

 

History

History
138 lines (98 loc) · 2.97 KB

README.md

File metadata and controls

138 lines (98 loc) · 2.97 KB

Garuda Hacks Admin Portal 🚀

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.

🛠️ 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
git clone https://github.com/your-username/gh-admin.git
cd gh-admin
  1. Install dependencies
npm install
  1. Set up environment variables
cp .env.example .env

Fill in your Firebase configuration in .env

  1. Start development server
npm run dev

Building for Production

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:

    # Format
<type>(<scope>): <description>

# 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

    Types: feat, fix, docs, style, refactor, test, chore Scope: optional, indicates the module affected

  4. Push to the branch (git push origin feat/amazing-feature)

  5. Open a Pull Request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

Made with ❤️ by the Garuda Hacks Team