first commit

README.md

@@ -1,36 +1,65 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+# Kozmos Beach & More
+
+**"Denizin Ormana Kıyısında" / "Where the Sea Meets the Forest"**
+
+Kozmos Beach & More is a modern, responsive, and bilingual (Turkish & English) corporate website built with Next.js 16 (App Router). It features a mobile-first design, a seamless single-page scrolling experience, and dedicated pages like Accommodation, all wrapped in a boho-chic, Aegean-inspired aesthetic.
+
+## Features
+
+- **Next.js 16 (App Router):** Fast, SEO-friendly, and modern architecture.
+- **i18n Support:** Fully bilingual (TR/EN) using `next-intl`.
+- **Styling:** Tailwind CSS v4 with custom gradients, colors, and an elegant typography system (Marcellus).
+- **Animations:** Smooth micro-interactions and scroll animations powered by `framer-motion`.
+- **Responsive Design:** Mobile-first approach, ensuring a flawless experience across all devices.
+- **Lightbox Gallery:** Custom-built image gallery with a full-screen lightbox feature.
+- **PWA & SEO Ready:** Pre-configured `manifest.ts`, `robots.ts`, `sitemap.ts`, and metadata.
+
+## Tech Stack
+
+- **Framework:** [Next.js](https://nextjs.org/)
+- **Language:** [TypeScript](https://www.typescriptlang.org/)
+- **Styling:** [Tailwind CSS v4](https://tailwindcss.com/)
+- **Animations:** [Framer Motion](https://www.framer.com/motion/)
+- **Icons:** [Lucide React](https://lucide.dev/)
+- **Internationalization:** [next-intl](https://next-intl-docs.vercel.app/)
+
+## Environment Variables
+
+To run the project locally, create a `.env.local` file with the following variables:
+
+```env
+# Contact number for WhatsApp reservation buttons
+NEXT_PUBLIC_WHATSAPP_NUMBER="905000000000"
+
+# URL for the QR menu (if applicable)
+NEXT_PUBLIC_MENU_URL="https://qr.kozmosbeach.com"
+```
 
 ## Getting Started
 
-First, run the development server:
+1. **Install dependencies:**
+   ```bash
+   npm install
+   ```
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+2. **Run the development server:**
+   ```bash
+   npm run dev
+   ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+3. **Build for production:**
+   ```bash
+   npm run build
+   npm run start
+   ```
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+## Development Commands
 
-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+- `npm run dev`: Starts the development server.
+- `npm run build`: Builds the app for production.
+- `npm run start`: Runs the built app in production mode.
+- `npm run lint`: Runs ESLint.
 
-## Learn More
+---
 
-To learn more about Next.js, take a look at the following resources:
-
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
-
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
-
-## Deploy on Vercel
-
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
-
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+*Created by [ayris.tech](https://ayris.tech)*