Skip to content

omgr/kalyanam

Repository files navigation

Kalyanam User Guide

Welcome to Kalyanam - Your Complete Wedding Planning Companion!

Table of Contents

  1. Getting Started
  2. Dashboard Overview
  3. Events & Ceremonies
  4. Guest Management
  5. Budget & Expenses
  6. Vendor Management
  7. Task Management
  8. Family Collaboration
  9. Messages & Communication
  10. Reminders & Alerts
  11. Location Tracking
  12. Settings & Customization

Getting Started

Creating Your Wedding

  1. Open Kalyanam in your browser
  2. Click "Start Planning" on the landing page
  3. Enter your wedding details:
    • Wedding name (e.g., "Priya & Rahul's Wedding")
    • Wedding date
    • Budget (optional)
    • Select your cultural tradition
  4. Add the bride and groom names
  5. Click "Create Wedding"

Preview Cultural Templates

Before creating a wedding, you can preview cultural rituals:

  1. Click "Browse cultural templates first" on the landing page
  2. Select a culture to see all included ceremonies
  3. Expand each ceremony to see details, significance, and required items
  4. Use this to verify the template matches your traditions

Logging In / Syncing to a New Device

If you already have wedding data on another device:

  1. Click "Login / Sync" on the landing page
  2. Choose your sync method:
    • Enter Sync Code: Get a 6-character code from the device with your data
    • Import Backup File: Upload a .kalyanam.json backup file
    • Select Existing Wedding: If you have weddings on this device already

Using Sync Code (Recommended for Remote Sync)

On the device WITH your data:

  1. Go to Sync & Backup from the menu
  2. Tap "Share from Here"
  3. Note the 6-character code displayed

On the new device:

  1. Click "Login / Sync"
  2. Select "Enter Sync Code"
  3. Enter the 6-character code
  4. Your wedding data transfers directly

Privacy First

All your data is stored locally on your device. No account required, no cloud servers - your wedding details stay private.


Dashboard Overview

The dashboard provides a quick overview of your wedding planning progress:

  • Countdown: Days remaining until your wedding
  • Quick Stats: Events, guests, tasks, and budget at a glance
  • Upcoming Events: Next ceremonies on your calendar
  • Pending Tasks: Tasks that need your attention
  • Budget Summary: How much you've spent vs. your total budget

Events & Ceremonies

Viewing Events

Navigate to Events from the sidebar to see all your ceremonies and events organized by date.

Adding a New Event

  1. Click "Add Event" button
  2. Fill in the event details:
    • Event Name (e.g., "Mehndi Ceremony")
    • Local Name (optional, e.g., "మెహెందీ")
    • Date and Time
    • Venue and Address
    • Category (Pre-wedding, Wedding Day, Post-wedding)
    • Assign family members
    • Budget for this event
  3. Add checklist items for the event
  4. Click "Create Event"

Cultural Templates

When you select a culture during setup, events are automatically populated with traditional ceremonies. For Telugu Brahmin weddings, this includes:

  • Nischitartham (Engagement)
  • Pellikuthuru/Pellikoduku
  • Snathakam
  • Kashi Yatra
  • Muhurtham (Main Wedding)
  • Talambralu
  • Saptapadi
  • Appaginthalu
  • And many more...

Managing Event Checklist

Each event can have a checklist of tasks:

  • Click on an event to view details
  • Add items to the checklist
  • Check off items as they're completed
  • Track progress with the visual progress bar

Guest Management

Adding Guests

  1. Go to Guests from the sidebar
  2. Click "Add Guest"
  3. Enter guest details:
    • Name
    • Phone number
    • Email (optional)
    • Side (Bride's/Groom's)
    • RSVP Status
    • Plus-ones count
    • Dietary restrictions
    • Group/Table assignment

RSVP Tracking

Filter guests by RSVP status:

  • Confirmed: Guests who have confirmed attendance
  • Pending: Awaiting response
  • Declined: Cannot attend
  • Maybe: Uncertain

Guest Statistics

View real-time stats:

  • Total invited guests
  • Confirmed attendees (including plus-ones)
  • Pending responses
  • Declined invitations

Budget & Expenses

Setting Up Budget Categories

Categories help organize your spending:

  • Venue & Decoration
  • Catering & Food
  • Photography & Video
  • Clothing & Jewelry
  • Music & Entertainment
  • And more...

Recording Expenses

  1. Go to Budget from the sidebar
  2. Click "Add Expense"
  3. Scan Receipt (Optional):
    • Click "Take Photo" to capture a receipt
    • Or "Upload" to select from files
  4. Fill in details:
    • Category
    • Description
    • Amount
    • Payment method (Cash, Card, UPI, Bank Transfer, Cheque)
    • Link to Vendor (optional)
  5. Payment Schedule (for installments):
    • Toggle "Pay in Installments"
    • Set number of installments
    • Choose start date
    • Click "Generate Schedule"
  6. Click "Add Expense"

Payment Tracking

Track different payment types:

One-Time Payments

  • Record the full amount
  • Mark as paid when completed

Installment Payments

  • Set up payment schedules
  • Get automatic reminders before due dates
  • Mark individual installments as paid
  • Track partial payments

Stage-Based Payments

  • Link payments to event milestones
  • Pay when specific stages are completed

Reconciliation

Match your expenses with bank transactions:

  1. Go to Budget → Reconciliation tab
  2. For each expense, enter the bank reference number
  3. Click "Reconcile" to mark as verified

Budget Analytics

  • View spending by category
  • Track budget utilization percentage
  • See pending payments
  • Monitor overdue amounts

Vendor Management

Adding Vendors

  1. Go to Vendors from the sidebar
  2. Click "Add Vendor"
  3. Enter vendor information:
    • Name and Category
    • Contact person and details
    • Quoted and final amounts
    • Advance paid
    • Contract and service dates
    • Rating (after service)

Vendor Categories

  • Photography
  • Videography
  • Catering
  • Decoration
  • Venue
  • Music/DJ
  • Makeup & Beauty
  • Mehendi Artist
  • Priest/Officiant
  • Florist
  • And more...

Payment Tracking per Vendor

  • Track quoted vs. final amounts
  • Record advance payments
  • Monitor pending balance
  • Set payment status (Pending, Partial, Paid)

Task Management

Creating Tasks

  1. Go to Tasks from the sidebar
  2. Click "Add Task"
  3. Fill in:
    • Task title
    • Description
    • Priority (Low, Medium, High, Urgent)
    • Due date
    • Assign to family members
    • Link to event (optional)

Task Priorities

  • Urgent: Red flag, needs immediate attention
  • High: Orange, important but not immediate
  • Medium: Yellow, standard priority
  • Low: Gray, can wait

Task Status

  • Pending: Not started
  • In Progress: Currently working on
  • Completed: Done
  • Cancelled: No longer needed

Family Collaboration

Adding Family Members

  1. Go to Family from the sidebar
  2. Click "Add Member"
  3. Enter details:
    • Name
    • Relation (Father, Mother, Sister, etc.)
    • Side (Bride's/Groom's)
    • Role (Organizer, Helper, Guest)
    • Contact information

Assigning Responsibilities

  • Assign tasks to specific family members
  • Assign events to be managed by family members
  • Track who's responsible for what

Messages & Communication

Sending Messages

  1. Go to Messages from the sidebar
  2. Click "New Message"
  3. Choose message type:
    • Message: Regular communication
    • Announcement: Important updates for everyone
    • Reminder: Time-sensitive notifications
    • Alert: Urgent matters

Message Priority

  • Normal: Standard messages
  • Important: Requires attention
  • Urgent: Immediate action needed

Sending to Specific People

  • Select "Everyone" to broadcast
  • Or choose specific family members

Read Receipts

  • See who has read your messages
  • Unread messages are highlighted

Reminders & Alerts

Creating Reminders

  1. Go to Reminders from the sidebar
  2. Click "Add Reminder"
  3. Set:
    • Title
    • Message (optional)
    • Date and time
    • Related to (Event, Task, Expense, Follow-up, or Custom)
    • Repeat (None, Daily, Weekly, Custom)

Automatic Reminders

Kalyanam automatically creates reminders for:

  • Payment installment due dates (3 days before)
  • Task deadlines
  • Event dates

Managing Reminders

  • View upcoming reminders
  • See overdue reminders highlighted in red
  • Mark reminders as completed
  • Delete reminders you no longer need

Location Tracking

How It Works

During busy wedding events, use location tracking to find family members:

GPS Tracking (Long Distance)

  • Share your location with family
  • See family members on a map
  • Get directions to reach someone

Zone-Based Tracking (Indoor)

Set up zones for venues:

  • Define areas (Main Hall, Kitchen, Gate, etc.)
  • Family members check into zones
  • Quickly see who is where

Privacy Controls

  • Enable/disable location sharing anytime
  • Choose who can see your location
  • Set location sharing duration

Sync & Backup

Kalyanam offers three free, privacy-focused ways to sync data between devices.

Export/Import File

  1. Go to Sync & Backup from the sidebar
  2. Click Export Data to download your wedding as a JSON file
  3. On another device, click Import Data to restore

QR Code Sync

  1. On Device A: Click Show QR Code
  2. On Device B: Click Scan QR Code
  3. Point camera at the QR code
  4. Data transfers automatically

P2P Real-time Sync

  1. On Device A: Click Share from Here
  2. Share the 6-character code with Device B
  3. On Device B: Enter the code and click Connect
  4. Data transfers directly between devices

See the Sync Guide for detailed instructions.


Settings & Customization

Wedding Settings

  • Edit wedding name and date
  • Update budget
  • Change cultural tradition
  • Manage bride/groom details

App Settings

  • Toggle dark/light mode
  • Configure notification preferences
  • Manage data backup
  • Export data

Data Management

  • Export: Download all your wedding data
  • Backup: Create local backups
  • Clear Data: Start fresh (use with caution)

Tips for Success

  1. Start Early: Begin planning 6-12 months before the wedding
  2. Update Regularly: Keep events, tasks, and budget current
  3. Assign Responsibilities: Don't try to do everything yourself
  4. Track Payments: Record all expenses as they happen
  5. Use Checklists: Break down events into manageable tasks
  6. Communicate: Use messages to keep family informed
  7. Set Reminders: Never miss important deadlines

Keyboard Shortcuts

Action Shortcut
Go to Dashboard G then D
Go to Events G then E
Go to Guests G then U
Go to Tasks G then T
Go to Budget G then B
Search /
Toggle Dark Mode Ctrl + D

Troubleshooting

Data Not Loading

  1. Refresh the page
  2. Check if you're in the correct wedding (if multiple)
  3. Clear browser cache and reload

Lost Data

  • Kalyanam stores data locally in your browser
  • Clearing browser data will remove wedding data
  • Use the export feature to backup regularly

Performance Issues

  • Close other browser tabs
  • Clear browser cache
  • Use a modern browser (Chrome, Firefox, Edge)

Support

If you encounter issues or have suggestions:

  • Check the documentation
  • Review the FAQ section
  • Create an issue on GitHub

Thank you for choosing Kalyanam for your wedding planning journey!

May your wedding be as beautiful as your love story. 💕

About

Welcome to Kalyanam - Your Complete Wedding Planning Companion!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages