> For the complete documentation index, see [llms.txt](https://hackathon-crew.gitbook.io/welcome-overview/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hackathon-crew.gitbook.io/welcome-overview/setup-guide/setup-guide.md).

# Setup Guide

#### Prerequisites:

\~ Node.js 18+

\~ npm

\~ Firebase account

\~ Google Gemini API key

### Backend Setup

```bash
# Clone repository
git clone https://github.com/your-username/museumquest.git

# Navigate to backend
cd backend

# Install dependencies
npm install

# Create .env file
GEMINI_API_KEY=your_key_here
FIREBASE_CREDENTIALS={"type":"service_account"...}

# Start server
npm start
```

Backend runs on `http://localhost:5000`

### Frontend Setup

```bash
# Navigate to frontend
cd frontend

# Install dependencies
npm install

# Start development server
npm run dev
```

Frontend runs on `http://localhost:5173`

### Environment Variables

#### Backend (.env)

* `GEMINI_API_KEY` - Google Gemini API key
* `FIREBASE_CREDENTIALS` - Firestore service account JSON
* `WOLFRAM_APP_ID` - (Optional) Wolfram Alpha app ID

#### Frontend

No environment variables needed for development. For production, update API URLs in `api.js`

### Deployment

#### Frontend (Netlify)

```bash
cd frontend
npm run build
netlify deploy --prod
```

#### Backend (Render)

* Connect GitHub repository
* Set root directory: `backend`
* Build command: `npm install`
* Start command: `npm start`
* Add environment variables in dashboard


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://hackathon-crew.gitbook.io/welcome-overview/setup-guide/setup-guide.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.