Overview#
Soiree is an editorial, magazine-style website for wedding and event planners. The demo brand is Ivy & Ash
Events, a fictional planning studio at 112 Church Street in Charleston, South Carolina, that offers full
planning, partial planning and day-of coordination for weddings, corporate events and private parties. This is
the Nuxt version: Nuxt 4 with Vue 3 single-file components, TypeScript and Tailwind CSS v4, generated as a
fully static site. It has the same pages, design and interactions as the HTML version, uses US spelling and US
dollars, and works out of time zone America/New_York. This guide covers version 1.0.1. The template page, with
a link to the live demo, is at freeframe.dev/templates/soiree.
Quick start#
-
Unzip the download and open a terminal in the folder.
-
Install and start the development server:
shpnpm install pnpm dev -
Visit
http://localhost:3000. Edit files inapp/and the page reloads.
Requirements: Node.js 24 and pnpm. pnpm install also runs nuxt prepare, which writes the types and the ESLint
config to .nuxt/. The fonts are bundled, so nothing loads from the internet.
| Command | What it does |
|---|---|
pnpm dev |
Development server with hot reload |
pnpm generate |
Static site in .output/public/ |
pnpm build |
Node.js server build in .output/ (pages still prerendered) |
pnpm preview |
Serve the last build locally |
pnpm lint |
ESLint |
pnpm typecheck |
nuxt prepare and vue-tsc |
Pages#
| Route | File | Purpose and notable features |
|---|---|---|
/ |
app/pages/index.vue |
Home: magazine-cover hero with a line-art "plate", "In this issue" contents, press names, founder's letter with studio numbers, the three packages, a pull quote, recent celebrations, process summary, estimator call to action, journal links |
/services |
app/pages/services.vue |
One section per package (#full, #partial, #dayof), comparison table (#compare), corporate and private events, add-on prices, FAQ (<details>) |
/estimator |
app/pages/estimator.vue |
Event type, guest count slider and number field, season, package, add-ons; live fee range, whole-celebration range, per-guest figure and spending breakdown; "Send this with an inquiry" link |
/portfolio |
app/pages/portfolio.vue |
Filter by type, eight case studies rendered from data, case-study dialog with previous/next, client quotes |
/process |
app/pages/process.vue |
Seven planning steps with timing and a "Where would you start?" date checker |
/venues |
app/pages/venues.vue |
Ten venues rendered from data; filter by area, setting and guest count; sort; save a shortlist; "Shortlist only" toggle |
/journal |
app/pages/journal.vue |
Feature article on costs, notes on rain plans, Thursday weddings and tipping (with a table), press and kind words |
/inquire |
app/pages/inquire.vue |
Inquiry form prefilled from the estimator or a case study, saved venues as checkboxes, validation with an error summary, confirmation with a reference |
| 404 | app/error.vue |
Friendly message and links to every page (generated as 404.html) |
Project structure#
soiree/
app/
app.vue <NuxtLayout><NuxtPage /></NuxtLayout>, with the key that starts a page over
error.vue 404 page
router.options.ts keeps query strings as the links write them
layouts/
default.vue skip link, header, the page, footer, toast and back-to-top button
pages/
index.vue home page
<route>.vue one file per page: services, estimator, portfolio, process, venues, journal, inquire
components/
SiteHeader.vue top bar, sticky header and the mobile menu
SiteFooter.vue footer
SiteYear.vue rolling years (top bar and copyright)
BudgetEstimator.vue budget estimator form and result panel
PortfolioBrowser.vue portfolio filter, grid and case-study dialog
ProcessPlanner.vue "Where would you start?" and the seven steps
VenueGuide.vue venue filters, list and shortlist
InquiryForm.vue inquiry form, error summary and confirmation
BackToTop.vue back-to-top button
ArrowIcon.vue the arrow after button and link labels
SaveIcon.vue the bookmark on the venue guide's save buttons
composables/
usePageSeo.ts title, description, canonical link, Open Graph tags and <body data-page>
useCurrentPage.ts aria-current for header and menu links
useAsset.ts asset() adds the base path to files in public/
data/
site.ts content and prices: packages, seasons, add-ons, venues, celebrations
process.ts the seven planning steps and their thresholds
nav.ts header, menu and footer links
utils/
estimate.ts estimator calculation and validation
dates.ts dates in Charleston time
shortlist.ts reading and saving the venue shortlist
safeStorage.ts localStorage with an in-memory fallback, storage keys and JSON helpers
toast.ts toast() and its state
url.ts getParams(), setParam(), replaceAddress() and reduceMotion()
format.ts money(), plural(), roundTo(), own()
plugins/
reveal.client.ts scroll reveals
same-page.client.ts links to the page already showing start it over, like a page load
stable-build.server.ts reproducible builds
assets/css/main.css Tailwind import, fonts, @theme tokens and the small component layer
assets/fonts/ Playfair Display and Mulish (Latin woff2) with their OFL license texts
public/img/
og-image.svg source of the social sharing image
og-image.png the social sharing image (1200x630)
hero-piazza.svg home page illustration (480x600)
art-*.svg line-art illustrations (400x500) for celebrations, venues and packages
favicon.svg the "&" monogram favicon
nuxt.config.ts base path, head defaults, SITE_URL, prerendered routes, Tailwind
eslint.config.mjs, tsconfig.json, pnpm-workspace.yaml
package.json, README.md, DOCS.md, CHANGELOG.md
LICENSE.txt license (in the download)Customizing#
Brand and colors#
All design tokens live in the @theme block of app/assets/css/main.css:
| Token | Value | Used for |
|---|---|---|
--color-ink |
#16130f |
Text, rules, dark sections, buttons |
--color-cream |
#f4ede1 |
Page background |
--color-paper |
#fbf7ef |
Cards, form fields, alternate sections |
--color-bone / --color-rule |
#ebe2d3 / #cdbfa8 |
Fine rules and dividers |
--color-muted |
#5f574d |
Secondary text |
--color-blush / --color-blush-soft |
#e8cfc3 / #f3e3db |
The accent surfaces |
--color-rose / --color-rose-deep |
#8f4c3e / #763c30 |
Accent text, italics, focus rings, bars |
--color-gold / --color-champagne |
#a88654 / #d9c39a |
Line-art details, accents on ink |
Each token becomes Tailwind utilities (bg-ink, text-rose, border-rule...). To change the accent, edit
the rose and blush tokens; the development server picks the change up at once:
@theme {
--color-rose: #2f5d50; /* deep green instead of rose */
--color-rose-deep: #244a40;
--color-blush: #cfe0d6;
--color-blush-soft: #e4eee8;
}Keep --color-rose dark enough for text on cream (at least 4.5:1). The illustrations in public/img/ have
their colors written into the SVG files; search and replace #8f4c3e, #a88654 and #f3e3db there too. The
browser's toolbar color is the theme-color meta tag in nuxt.config.ts.
Typography#
Two fonts are self-hosted: Playfair Display (display serif, with italics) and Mulish (body text). The
@font-face rules at the top of app/assets/css/main.css load the Latin woff2 files in app/assets/fonts/ under
their real family names, and the @theme block sets them as --font-display and --font-sans:
@font-face {
font-family: "Playfair Display";
font-style: normal;
font-weight: 400 700;
font-display: swap;
src: url("../fonts/PlayfairDisplay-latin.woff2") format("woff2");
}--font-sans: "Mulish", ui-sans-serif, system-ui, ...;
--font-display: "Playfair Display", "Didot", "Bodoni 72", Georgia, "Times New Roman", serif;To swap a font, put its woff2 files in app/assets/fonts/, change the @font-face rules and use the same
family name in --font-display or --font-sans. Headings use the display, headline, pull-quote and
font-display classes; small uppercase labels use kicker and smallcaps.
Content#
Page text lives in the page files under app/pages/. Data that the components render or calculate with lives in
app/data/site.ts, as typed constants:
| Name | Shape | Used by |
|---|---|---|
TIME_ZONE |
"America/New_York" |
Dates on Process and Inquire, the rolling years |
PACKAGES |
{ full, partial, dayof } each { name, base, perGuest, blurb } |
Estimator fee and package list |
EVENT_TYPES |
{ wedding, corporate, private } each { name, perGuest } |
Estimator vendor spend |
SEASONS |
{ peak, summer, winter } each { name, months, feeFactor, spendFactor } |
Estimator |
ADDONS |
{ welcome, rehearsal, brunch, transport, design } each { name, price } |
Estimator fee and add-on list |
BREAKDOWN |
[{ name, share }], shares adding up to 1 |
Estimator breakdown |
GUEST_LIMITS |
{ min: 20, max: 400, step: 10, initial: 120 } |
Estimator guests |
SPREAD |
{ fee: [0.95, 1.1], spend: [0.85, 1.2] } |
Low and high ends of each range |
AREAS |
{ downtown, "mount-pleasant", islands, rural, north } → label |
Venue filter and labels |
SETTINGS |
{ indoor, outdoor, both } → label |
Venue filter and labels |
VENUES |
[{ id, name, area, setting, min, max, priceFrom, art, note }] |
Venue guide, inquiry shortlist |
EVENT_TYPE_LABELS |
{ wedding, corporate, private } → label |
Portfolio labels |
CELEBRATIONS |
[{ id, title, type, date, venue, guests, pkg, art, headline, summary, story, details, quote, by }] |
Portfolio grid and dialog |
app/data/process.ts has STEPS, the seven planning steps ({ from, when, title, text }).
To add a venue, append an object to VENUES (its art is the middle of a public/img/art-*.svg file name):
{ id: "magnolia-hall", name: "Magnolia Hall", area: "downtown", setting: "indoor", min: 40, max: 180,
priceFrom: 7200, art: "loft", note: "A restored 1890s meeting hall with a sprung dance floor." },Use a new, URL-safe id, an area that exists in AREAS and a setting that exists in SETTINGS. The Area
and Setting selects are built from AREAS and SETTINGS, so a new area appears there by itself. Celebrations
work the same way; their type must be a key of EVENT_TYPE_LABELS. The estimator's package and add-on lists
read their names and prices from PACKAGES and ADDONS, but package prices are also written in the page text
(home, services and the comparison table): update both when you change them.
Images and artwork#
All artwork is SVG line art drawn for this template: hero-piazza.svg (480x600) on the home page and eight
art-*.svg files (400x500, a 4:5 ratio) for celebrations, venues and packages, all in public/img/. To use
photos instead, keep a similar ratio (4:5 portrait) and point the <img> tags or the art values at your
files; frames crop with object-fit: cover. Images are plain <img> tags whose src goes through asset()
from app/composables/useAsset.ts (const asset = useAsset()), which adds the base path. Decorative images
have alt=""; give real photos meaningful alt text.
The social image is public/img/og-image.png (1200x630), generated from og-image.svg. The favicon is
public/img/favicon.svg, linked in nuxt.config.ts.
Navigation, header and footer#
The links are in app/data/nav.ts: MAIN (left of the logo), SECONDARY (right of it) and MENU (the mobile
menu and the footer list, in order). app/components/SiteHeader.vue renders the top bar, both header lists,
the "Inquire" button and the full-screen mobile menu (#mobile-menu) with numbered links, and marks the current
page with aria-current="page"; app/components/SiteFooter.vue renders the footer. To add a page, create
app/pages/<route>.vue with a <main id="main"> root and a usePageSeo() call, add "/<route>" to routes in
nuxt.config.ts, and add { href: "/<route>", label: "…" } to MAIN or SECONDARY (and so to MENU).
The years in the top bar ("Now booking 2027 & 2028") and the footer copyright come from
app/components/SiteYear.vue, which reads today's date in Charleston: <SiteYear /> shows this year and
<SiteYear :ahead="1" /> / <SiteYear :ahead="2" /> show next year and the year after, so the site never
advertises a season that has passed. The generated HTML carries the year in WRITTEN (in SiteYear.vue) and
the browser corrects it when the page starts. To show fixed years, replace the components with plain text.
Features#
Budget estimator#
/estimator, in app/components/BudgetEstimator.vue with the calculation in app/utils/estimate.ts. The
visitor picks an event type, guest count, season, package and add-ons; the panel updates at once.
- Planning fee = (
base+perGuestx guests above 50) x seasonfeeFactor+ add-on prices. The range is the fee timesSPREAD.fee, rounded to $100. - Vendor spend = guests x event type
perGuestx seasonspendFactor. The whole-celebration range is spend timesSPREAD.spendplus the fee range, rounded to $500. The per-guest figure is the midpoint divided by guests, rounded to $10. - The breakdown multiplies the spend range by each
BREAKDOWNshare. - "Full design and styling" is part of full planning, so it is checked and disabled for that package.
- With the defaults (wedding, 120 guests, spring or fall, full planning, no add-ons) it shows $18,100 – $20,900 for the fee and $50,500 – $67,000 for the whole celebration, about $490 per guest.
- The number field accepts whole numbers from 20 to 400 as you type; leaving it rounds the number and keeps it inside the limits. The slider moves in steps of 10.
?package=full|partial|dayof(used by the Services page) selects a package. Choices are saved undersoiree-estimate. "Start over" restores the defaults and clears the saved value.- "Send this with an inquiry" links to
/inquire?package=…&guests=…&type=…. computeEstimate(cleanEstimate(state))fromapp/utils/estimate.tsreturns the calculation, for testing or reuse.
Every figure is labeled as an estimate only, not a quote. Accessibility: native radio buttons and checkboxes in fieldsets with legends; the slider and number field are labeled; a polite live region announces the new ranges half a second after the last change.
Portfolio filter and case studies#
/portfolio, in app/components/PortfolioBrowser.vue. Cards are rendered from CELEBRATIONS in a staggered
seven/five column grid. The filter buttons (data-filter) use aria-pressed, show counts and update a
polite status ("Showing 2 celebrations"). The filter is kept in the URL as ?type=wedding|corporate|private.
Each card title is a button that opens a native <dialog> with the full story. ?case=<id> opens a story
directly (if it's hidden by the filter, the filter resets to All). In the dialog, previous/next buttons and the
Left/Right arrow keys move through the visible stories, Esc or a click on the backdrop closes it, and focus
returns to the story's card. "Plan something like this" links to /inquire?type=<type>.
Venue guide and shortlist#
/venues, in app/components/VenueGuide.vue. Filters: Area (?area= in the URL), Setting, Guests
(venues whose minimum and maximum include the number) and Sort (name ignoring a leading "The", lowest price,
largest capacity). "Shortlist only" (aria-pressed) shows saved venues. Each "Save" button is a toggle with
aria-pressed and a toast confirms the change. When nothing matches, an empty state offers "Clear filters".
The shortlist is saved under soiree-shortlist (app/utils/shortlist.ts) and appears on the inquiry form.
Where would you start?#
/process, in app/components/ProcessPlanner.vue. The visitor enters an event date; the component works out
the whole months between today in Charleston (America/New_York) and that date, then marks the first step
whose from (months ahead) is at or below it with "Start here" (is-current), dims earlier steps (is-past)
and explains the result ("Your date is 14 months away: perfect timing."). Dates must be after today and
within three years. Change the thresholds with the from values in app/data/process.ts.
Header, reveals and back to top#
The mobile menu button uses aria-expanded and aria-controls, Esc closes the menu and returns focus, and
it closes when the screen grows to desktop width. Elements with the reveal class fade in on scroll
(app/plugins/reveal.client.ts, an IntersectionObserver that adds is-in), with an optional delay from
style="--d:80ms", and everything shows at once with reduced motion. The plugin adds the class to the element
itself, so don't put reveal on an element whose :class binding changes. The back-to-top button is
app/components/BackToTop.vue, styled by the .back-to-top rules in app/assets/css/main.css; remove its line
from app/layouts/default.vue and delete both to drop it. Toasts come from toast("…") in app/utils/toast.ts.
Dates, addresses and the static build#
The pages are generated once as static HTML, so anything that depends on today's date, the address (?type=,
?package=…) or saved data is filled in by the browser. The estimator, portfolio, venue guide and inquiry form
render their plain starting state first and read the address (getParams() in app/utils/url.ts) and storage
in onMounted(); the date limits on the Process and Inquire pages and the rolling years are set there too. That
keeps the generated HTML and the first render in the browser identical, which avoids hydration warnings. Keep
that pattern when you add a component that reads the address, localStorage or the clock.
Components change the address with setParam() from app/utils/url.ts, which uses history.replaceState, so
filters never add history entries and the Back button leaves the page.
Links to the page already showing#
On a static site a link to the current page reloads it. Here app/plugins/same-page.client.ts gives such links
(Portfolio in the header while a filter is on, Inquire after the form was sent) the same result: it raises the
page-reloads counter that is part of the page key in app/app.vue, so the page is built again, scrolled to
the top with nothing focused, and its filters, forms and open FAQ answers start over and read the new address.
Forms#
Inquiry form#
/inquire, in app/components/InquiryForm.vue. It validates when submitted, then live as the visitor corrects
fields:
| Field | Rule |
|---|---|
| Your name | Required |
Required, name@domain.tld shape |
|
| Phone | Optional; if filled, at least 10 digits |
| Type of event | Required (wedding, corporate or private) |
| Event date | A real date after today and within three years, in Charleston time; may be empty if "Our date is flexible" is checked |
| Guest count | Required whole number from 10 to 500 |
| Overall budget | Required band |
| Message | At least 20 characters (2,000 maximum, with a counter) |
Errors appear under each field (aria-invalid and aria-describedby) and in an error summary that takes
focus and links to each field. The form reads ?package=, ?guests= and ?type= from the URL (validated
against the data), shows a note when it came from the estimator, and lists shortlisted venues as checked
checkboxes. On success it shows a reference (IA- and four characters, made in the browser by makeRef()),
the reply promise from the "What happens next" list and a summary of the inquiry. "Start a new inquiry" brings
back an empty form.
Connecting a real backend#
The form doesn't send anything until you connect it, although its confirmation reads as if it had. In
app/components/InquiryForm.vue, find the comment "Connect your form here" in onSubmit. With a service such
as Formspree, send the data there before the confirmation is shown:
const response = await fetch("https://formspree.io/f/your-id", {
method: "POST",
body: new FormData(el),
headers: { Accept: "application/json" },
});
if (!response.ok) {
problems.value = [{ id: "inq-name", text: "We couldn’t send your inquiry. Please try again." }];
summaryShown.value = true;
await nextTick();
summary.value?.focus();
return;
}With a server deployment (pnpm build instead of pnpm generate, see
Building and deploying) you can post to your own server route instead: create
server/api/inquire.post.ts with export default defineEventHandler(async (event) => { … }), read the fields
with await readFormData(event) and pass them to your email service or CRM, then fetch("/api/inquire", …)
from onSubmit.
The date checker on the Process page is not a form submission and sends nothing.
Saved data (localStorage)#
| Key | Shape | Validation on read | Reset |
|---|---|---|---|
soiree-estimate |
{ type, guests, season, pkg, addons: [] } |
cleanEstimate in app/utils/estimate.ts: each value checked with an own-key lookup against EVENT_TYPES, SEASONS, PACKAGES and ADDONS; guests rounded and clamped to 20–400; duplicate or unknown add-ons dropped; invalid JSON removed |
"Start over" on the estimator |
soiree-shortlist |
["venue-id", ...] |
readShortlist in app/utils/shortlist.ts: must be an array; unknown or duplicate ids are dropped and the cleaned list saved back |
Unsave venues, or localStorage.removeItem("soiree-shortlist") |
All storage goes through safeStorage in app/utils/safeStorage.ts, which also has the key names
(ESTIMATE_KEY, SHORTLIST_KEY) and the JSON helpers (store.get, store.set, store.remove). When the
browser blocks localStorage (a sandboxed iframe or strict privacy settings), it uses an in-memory stand-in, so
the estimator and shortlist still work for the rest of the page view.
SEO and sharing#
Each page sets its title, description and Open Graph tags with usePageSeo() from
app/composables/usePageSeo.ts, which also adds a canonical link. URLs are absolute: set SITE_URL to your
domain when you build (SITE_URL=https://ivyandash.example pnpm generate), so og:image (/img/og-image.png)
and the canonical links point at your site, which most social sites require. The 404 page is marked noindex.
Add a public/robots.txt and a sitemap (by hand, or with a module such as @nuxtjs/sitemap) if you want them,
and consider LocalBusiness structured data (JSON-LD) with your address and phone number.
Accessibility#
- Skip link, landmarks (
header, labelednavs,main,footer), one<h1>per page and a logical heading order. - Visible focus rings (rose on light, champagne on ink), AA contrast for text, and a light color scheme only.
- Toggle buttons use
aria-pressed; the menu usesaria-expanded; status text uses polite live regions; the case study uses a native modal<dialog>with focus return. - Form fields have labels, hints and errors linked with
aria-describedby; radio groups are fieldsets. - Scroll reveals, dialog animation and smooth scrolling are off with
prefers-reduced-motion. - The comparison and tipping tables scroll inside a labeled, focusable region on small screens.
When editing, keep one <h1> per page, label every new input, and keep every aria-controls,
aria-labelledby and aria-describedby pointing at an id that exists.
Building and deploying#
pnpm generate writes a static site to .output/public/, with every route listed in routes in
nuxt.config.ts prerendered to <route>.html (services.html, served at /services) and the 404 page to
404.html:
- Netlify / Cloudflare Pages / Vercel: build command
pnpm generate, publish directory.output/public. - Any static host: upload the contents of
.output/public/. The host should serve/servicesfromservices.html(most do) and404.htmlfor unknown paths.
To serve from a sub-folder, build with DEMO_BASE_PATH=/events pnpm generate; nuxt.config.ts turns it into
app.baseURL, which every link, script and asset uses. pnpm build:demo does this for the freeframe.dev demo
(demo/, which you can delete).
Tailwind scans the source files for class names; keep each class name whole (not built from pieces such as
`col-span-${n}`), or it won't be generated. The <body> classes are set in nuxt.config.ts, which
app/assets/css/main.css names with @source so they are generated too.
To use server features (server routes in server/api/), run pnpm build and deploy .output/ to a host that
runs Node.js.
TypeScript setup#
typescript is installed as an alias of @typescript/typescript6, the TypeScript 6 API that vue-tsc needs.
tsconfig.json only references the configs Nuxt writes to .nuxt/, so run pnpm install (or nuxt prepare)
before pnpm typecheck or pnpm lint.
Troubleshooting#
- New Tailwind classes have no effect. Class names built from pieces aren't generated; write them out in full.
- The estimator keeps old choices. They're saved under
soiree-estimate; press "Start over" or clear the site's storage. - A shortlisted venue disappeared after editing
app/data/site.ts. Saved ids that no longer exist inVENUESare dropped. Keep ids stable when renaming venues. - A date is rejected as "after today" near midnight. Dates use Charleston time (
America/New_York). ChangeTIME_ZONEinapp/data/site.tsif your business is elsewhere. - The inquiry form says it's done but no email arrives. It sends nothing until connected; follow Connecting a real backend.
- Shared links show no image. Build with
SITE_URLset to your domain soog:imageis an absolute URL. - Images break under a sub-folder. Use
asset()for files inpublic/and build withDEMO_BASE_PATH. - A new page shows the 404 page after
pnpm generate. Add its route toroutesinnuxt.config.ts. - A hydration warning after editing a component. Values that depend on the clock, the URL or storage must
be read in
onMounted(), not while the component renders; see Dates, addresses and the static build. pnpm lintcan't find.nuxt/eslint.config.mjs. Runpnpm installorpnpm typecheckfirst.
License#
MIT. The code and all included artwork are free for personal and commercial use; see LICENSE.txt in the
download.
Playfair Display and Mulish are included under the SIL Open Font License (see app/assets/fonts/).
Ivy & Ash Events, its people, clients, venues and publications are fictional placeholders.