This guide walks you through cloning the repository, installing dependencies, and opening a live invitation preview in your local browser. By the end you will have a fully functional development server running and understand how to build the project for static deployment — all in under five minutes.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/gus-16710/invitations/llms.txt
Use this file to discover all available pages before exploring further.
Prerequisites
Before you begin, make sure you have the following installed:- Node.js 18 or later — nodejs.org/en/download
- npm (bundled with Node.js) or an alternative package manager (yarn, pnpm, or bun)
Setup Steps
Install dependencies
Install all required packages using your preferred package manager:This installs Next.js 16, React 19, Framer Motion, Swiper, NextUI, Tailwind CSS, Lenis, and all other dependencies listed in
package.json.Start the development server
Launch the Next.js development server:The server starts on http://localhost:3000. You will see the platform’s landing page, which showcases all available invitation categories with a live confetti demo and an animated feature overview.
Open an existing invitation
Navigate directly to any invitation route in your browser. Here are several examples you can try immediately:
Each URL loads a fully self-contained invitation page with its own fonts, animations, photo gallery, and section layout.
| Category | Example URL |
|---|---|
| Wedding | http://localhost:3000/bodas/diana-ernesto |
| Quinceañera | http://localhost:3000/quinces/daniela |
| School graduation | http://localhost:3000/escolar/cobaev-66 |
| Quinceañera | http://localhost:3000/quinces/camila |
| Wedding | http://localhost:3000/bodas/citlali-daniel |
Build for production
When you are ready to deploy, generate the full static export:Next.js crawls every route in the app and emits a complete set of static HTML, CSS, and JavaScript files into the
out/ directory at the project root. The contents of out/ can be deployed to any static hosting provider (Vercel, Netlify, Cloudflare Pages, S3, etc.) with zero server configuration.images.unoptimized: true is set in next.config.js. This is required
for static export because Next.js’s built-in image optimization relies on
a server-side API route, which is unavailable in output: 'export' mode.
All <Image /> components render standard <img> tags at build time.Available Scripts
The following npm scripts are defined inpackage.json:
| Script | Command | Description |
|---|---|---|
| Development server | npm run dev | Starts Next.js in development mode with hot reload at http://localhost:3000 |
| Production build | npm run build | Runs next build and outputs static files to the out/ directory |
| Production server | npm run start | Starts a Next.js server for local testing (requires a standard build, not the static out/ export) |
| Linter | npm run lint | Runs ESLint across the codebase using Next.js’s built-in ESLint configuration |