⭐️ Camp Starfish ⭐️

Welcome to the official repository for the Camp Starfish Photo & Scheduling App, developed by Hack4Impact-UMD! 🎉

This repository contains everything you need code, documentation, and setup guides to effectively contribute to the Camp Starfish app. Follow the setup guide below to get started quickly. Feel free to reach out to the team if you have any questions!

---

📖 Quick Navigation

• Environment Setup
• Project Structure
• Team Contacts

---

⚙️ Environment Setup

Get started quickly by setting up your local environment:

📂 Initial Steps

1. GitHub SSH Configuration:

   • Follow this GitHub Guide.

2. Clone the Repository:

   git clone [email protected]:Hack4Impact-UMD/camp-starfish.git
   cd camp-starfish

🌐 Running the App Locally

Install dependencies and run the development server:

npm install
npm run dev

Open http://localhost:3000 to see your running application.

🔥 Firebase Local Emulator

To simulate Firebase locally:

1. Install Firebase CLI

npm install -g firebase-tools
firebase login

2. Install dependencies

cd functions
npm install

3. Run Emulators with Test Data

firebase emulators:start ./testData

4. Start the Local Development Server Open a new terminal and run the following:

npm run dev

5. Compile Cloud Functions To compile Cloud Functions locally, open a new terminal and run the following:

cd functions
npm run build

⚠️ Use the Firebase Emulators for local testing only.

---

🏗️ System Design

Here's how the project directories are structured:

camp-starfish/
│── .next/
│── functions/
│── node_modules/
│── public/
│── src/
│   ├── app/                # Next.js App Router
│   ├── assets/             # Images and static files
│   ├── auth/               # Authentication modules
│   ├── components/         # UI components
│   ├── config/             # App configurations
│   ├── data/               # Data operations
|   ├── features/           # Individual app features
│   ├── types/              # Type definitions
│── .env
│── .firebaserc
│── .gitignore
│── eslint.config.mjs
│── firebase.json
│── firestore.indexes.json
│── firestore.rules
│── next.config.ts
│── package-lock.json
│── package.json
│── postcss.config.mjs
│── README.md
│── storage.rules
│── tailwind.config.ts
│── tsconfig.json

---

📞 Team Contacts

Name	Role	Contact
Nitin Kanchinadam	Tech Lead	[email protected]
Benjamin Enwesi	Tech Lead	[email protected]

---

🎉 Happy coding! Together, we’ll make Camp Starfish amazing! ⭐️