@titas_mallick/wedding-site-gen 1.0.1 → 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.
Files changed (2) hide show
  1. package/README.md +49 -43
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,6 +1,25 @@
1
- # Titas & Sukanya's Wedding: A Modern AI-Powered Platform
1
+ # AI-Powered Wedding Website Generator 💍
2
2
 
3
- A comprehensive, interactive, and intelligent web application built for the wedding of Titas and Sukanya. This platform serves as a digital invitation hub, a real-time event assistant, and a collaborative memory wall.
3
+ Create a stunning, interactive, and intelligent wedding website in seconds. This tool scaffolds a complete Next.js application tailored to your wedding.
4
+
5
+ ## 🚀 Quick Start (No Installation Required)
6
+
7
+ Simply run the following command in your terminal:
8
+
9
+ ```bash
10
+ npx @titas_mallick/wedding-site-gen
11
+ ```
12
+
13
+ ### What happens next?
14
+ 1. **Interactive Setup**: The CLI will ask for:
15
+ - Groom & Bride Names
16
+ - Wedding Date & Location Details
17
+ - Admin Email (for managing guestbook & song requests)
18
+ - UPI ID (for digital gifts)
19
+ 2. **Scaffolding**: It will generate a new folder with your personalized wedding website.
20
+ 3. **Deployment Ready**: Follow the onscreen instructions to install dependencies and start your site!
21
+
22
+ ---
4
23
 
5
24
  ## ✨ Core Features
6
25
 
@@ -30,47 +49,34 @@ A comprehensive, interactive, and intelligent web application built for the wedd
30
49
  - **Image Hosting**: Cloudinary (Unsigned Uploads)
31
50
  - **Analytics**: Vercel Analytics
32
51
 
33
- ## 🛠️ Setup & Maintenance
34
-
35
- ### 1. Environment Variables
36
- Create a `.env.local` file with the following keys:
37
-
38
- ```bash
39
- # Firebase Client Config
40
- NEXT_PUBLIC_APIKEY=
41
- NEXT_PUBLIC_AUTHDOMAIN=
42
- NEXT_PUBLIC_PROJECTID=
43
- NEXT_PUBLIC_STORAGEBUCKET=
44
- NEXT_PUBLIC_SENDERID=
45
- NEXT_PUBLIC_APPID=
46
- NEXT_PUBLIC_MEASUREMENTID=
47
- NEXT_PUBLIC_RECAPTCHA_SITE_KEY=
48
-
49
- # Google Gemini AI
50
- NEXT_PUBLIC_GEMINI_API_KEY=
51
-
52
- # Cloudinary Config
53
- NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME=
54
- NEXT_PUBLIC_CLOUDINARY_UPLOAD_PRESET= # Should be an 'Unsigned' preset
55
- ```
56
-
57
- ### 2. Admin Access
58
- The configured admin email has primary administrator privileges. When logged in with this account:
59
- - **Guestbook**: A delete button appears on all guest photos.
60
- - **Song Requests**: "Mark as Played" and "Delete" controls are enabled in the queue.
61
- - **Updates**: Ability to post and refine messages via AI.
62
-
63
- ### 3. Cloudinary Configuration
64
- To enable guest uploads:
65
- 1. Create a Cloudinary account.
66
- 2. Go to **Settings > Upload**.
67
- 3. Create an **Unsigned Upload Preset** named `wedding`.
68
- 4. Update the `NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME` in `.env.local`.
69
-
70
- ### 4. OBS Overlay Setup
71
- - **URL**: `https://your-domain.com/updates/overlay`
72
- - **Recommended Res**: 1920x1080
73
- - **Filter**: Add a **Chroma Key** filter in OBS and select **Green** to remove the background.
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!
78
+
79
+ ---
74
80
 
75
81
  ## 📁 Project Structure Highlights
76
82
  - `/app/invitation/[slug]`: The core personalized guest experience.
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "@titas_mallick/wedding-site-gen",
3
- "version": "1.0.1",
3
+ "version": "1.0.3",
4
4
  "bin": {
5
- "create-wedding-site": "./cli.mjs"
5
+ "wedding-gen": "./cli.mjs"
6
6
  },
7
7
  "scripts": {
8
8
  "dev": "next dev --turbopack",