@titas_mallick/wedding-site-gen 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -40
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -49,47 +49,34 @@ npx @titas_mallick/wedding-site-gen
|
|
|
49
49
|
- **Image Hosting**: Cloudinary (Unsigned Uploads)
|
|
50
50
|
- **Analytics**: Vercel Analytics
|
|
51
51
|
|
|
52
|
-
## 🛠️ Setup &
|
|
52
|
+
## 🛠️ Setup & Configuration
|
|
53
|
+
|
|
54
|
+
To make the website fully functional (AI Concierge, Guestbook uploads, and RSVPs), you need to set up three free services:
|
|
55
|
+
|
|
56
|
+
### 1. Firebase (Database, Auth, and RSVP)
|
|
57
|
+
1. Go to the [Firebase Console](https://console.firebase.google.com/).
|
|
58
|
+
2. Create a new project.
|
|
59
|
+
3. Enable **Firestore Database** and **Authentication** (enable Email/Password provider).
|
|
60
|
+
4. Go to **Project Settings > General** and scroll down to "Your apps" to create a Web App.
|
|
61
|
+
5. Copy the `firebaseConfig` values into your `.env.local`:
|
|
62
|
+
- `NEXT_PUBLIC_APIKEY`, `NEXT_PUBLIC_AUTHDOMAIN`, `NEXT_PUBLIC_PROJECTID`, etc.
|
|
63
|
+
6. **Admin SDK**: Go to **Project Settings > Service accounts**, click "Generate new private key", and use those values for the `FIREBASE_ADMIN_*` variables in `.env.local`.
|
|
64
|
+
|
|
65
|
+
### 2. Google Gemini (AI Concierge)
|
|
66
|
+
1. Go to the [Google AI Studio](https://aistudio.google.com/).
|
|
67
|
+
2. Click **"Get API key"**.
|
|
68
|
+
3. Copy the key and paste it as `NEXT_PUBLIC_GEMINI_API_KEY` in your `.env.local`.
|
|
69
|
+
|
|
70
|
+
### 3. Cloudinary (Guestbook Photo Uploads)
|
|
71
|
+
1. Create a free account at [Cloudinary](https://cloudinary.com/).
|
|
72
|
+
2. Go to **Dashboard** and copy your **Cloud Name** into `NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME`.
|
|
73
|
+
3. Go to **Settings > Upload** and scroll down to **Upload presets**.
|
|
74
|
+
4. Click "Add upload preset".
|
|
75
|
+
5. Set **Signing Mode** to **Unsigned**.
|
|
76
|
+
6. Set the name to `wedding` (or match whatever you put in `NEXT_PUBLIC_CLOUDINARY_UPLOAD_PRESET`).
|
|
77
|
+
7. Save and you're ready!
|
|
53
78
|
|
|
54
|
-
|
|
55
|
-
Create a `.env.local` file with the following keys:
|
|
56
|
-
|
|
57
|
-
```bash
|
|
58
|
-
# Firebase Client Config
|
|
59
|
-
NEXT_PUBLIC_APIKEY=
|
|
60
|
-
NEXT_PUBLIC_AUTHDOMAIN=
|
|
61
|
-
NEXT_PUBLIC_PROJECTID=
|
|
62
|
-
NEXT_PUBLIC_STORAGEBUCKET=
|
|
63
|
-
NEXT_PUBLIC_SENDERID=
|
|
64
|
-
NEXT_PUBLIC_APPID=
|
|
65
|
-
NEXT_PUBLIC_MEASUREMENTID=
|
|
66
|
-
NEXT_PUBLIC_RECAPTCHA_SITE_KEY=
|
|
67
|
-
|
|
68
|
-
# Google Gemini AI
|
|
69
|
-
NEXT_PUBLIC_GEMINI_API_KEY=
|
|
70
|
-
|
|
71
|
-
# Cloudinary Config
|
|
72
|
-
NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME=
|
|
73
|
-
NEXT_PUBLIC_CLOUDINARY_UPLOAD_PRESET= # Should be an 'Unsigned' preset
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
### 2. Admin Access
|
|
77
|
-
The configured admin email has primary administrator privileges. When logged in with this account:
|
|
78
|
-
- **Guestbook**: A delete button appears on all guest photos.
|
|
79
|
-
- **Song Requests**: "Mark as Played" and "Delete" controls are enabled in the queue.
|
|
80
|
-
- **Updates**: Ability to post and refine messages via AI.
|
|
81
|
-
|
|
82
|
-
### 3. Cloudinary Configuration
|
|
83
|
-
To enable guest uploads:
|
|
84
|
-
1. Create a Cloudinary account.
|
|
85
|
-
2. Go to **Settings > Upload**.
|
|
86
|
-
3. Create an **Unsigned Upload Preset** named `wedding`.
|
|
87
|
-
4. Update the `NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME` in `.env.local`.
|
|
88
|
-
|
|
89
|
-
### 4. OBS Overlay Setup
|
|
90
|
-
- **URL**: `https://your-domain.com/updates/overlay`
|
|
91
|
-
- **Recommended Res**: 1920x1080
|
|
92
|
-
- **Filter**: Add a **Chroma Key** filter in OBS and select **Green** to remove the background.
|
|
79
|
+
---
|
|
93
80
|
|
|
94
81
|
## 📁 Project Structure Highlights
|
|
95
82
|
- `/app/invitation/[slug]`: The core personalized guest experience.
|