Skip to content

UltimateMenu/ultimatemenu.github.io

Repository files navigation

UltimateMenu Showcase Website

A modern, dynamic showcase website for UltimateMenu - the most advanced YimMenu Lua script for GTA V.

🌐 Live Deployments

πŸ› οΈ Built With

Core Technologies

UI Components & Libraries

Analytics & Tracking

Additional Tools

πŸ“ Project Structure

showcase-page-design/
β”œβ”€β”€ app/                      # Next.js App Router pages
β”‚   β”œβ”€β”€ changelog/           # Changelog page (fetches from GitHub)
β”‚   β”œβ”€β”€ installation/        # Installation guide page
β”‚   β”œβ”€β”€ layout.tsx           # Root layout with theme provider
β”‚   └── page.tsx             # Home page
β”œβ”€β”€ components/              # React components
β”‚   β”œβ”€β”€ ui/                  # Reusable UI components (shadcn/ui)
β”‚   β”œβ”€β”€ changelog-list.tsx   # GitHub releases display
β”‚   β”œβ”€β”€ footer.tsx           # Site footer
β”‚   β”œβ”€β”€ header.tsx           # Navigation header
β”‚   β”œβ”€β”€ hero.tsx             # Hero section
β”‚   β”œβ”€β”€ features.tsx         # Features showcase
β”‚   β”œβ”€β”€ stats.tsx            # GitHub stats & visitor counter
β”‚   β”œβ”€β”€ screenshots.tsx      # Image gallery
β”‚   β”œβ”€β”€ screenshot-carousel.tsx  # Auto-rotating carousel
β”‚   β”œβ”€β”€ video-showcase.tsx   # YouTube video embed
β”‚   β”œβ”€β”€ markdown-renderer.tsx    # Markdown content renderer
β”‚   └── visitor-counter.tsx  # Visitor tracking component
β”œβ”€β”€ lib/                     # Utility functions
└── public/                  # Static assets

✨ Features

🎨 Modern UI/UX

  • Responsive design for all screen sizes
  • Dark mode support with smooth transitions
  • Glassmorphism effects on navigation
  • Animated text sweeps and gradient effects
  • Smooth scroll animations with Framer Motion

πŸ“Š Real-Time Statistics

  • GitHub Stars: Live count from GitHub API
  • GitHub Forks: Live count from GitHub API
  • Page Views: Real visitor tracking via visitor.6developer.com

πŸ–ΌοΈ Interactive Gallery

  • Auto-rotating carousel (3-second intervals)
  • Lightbox image preview with navigation
  • Hover effects and smooth transitions

πŸ“ Dynamic Content

  • Changelog: Fetches latest releases from GitHub API
  • Installation Guide: Markdown-based with image support
  • GitHub-flavored Markdown: Proper rendering with syntax highlighting

πŸ”— External Integrations

  • GitHub API for repository stats and releases
  • YouTube video embedding
  • Discord server integration
  • Social media links

πŸš€ Getting Started

Prerequisites

  • Node.js 18+
  • npm or pnpm

Installation

# Clone the repository
git clone https://github.com/ultimatemenu/showcase-page-design.git

# Navigate to project directory
cd showcase-page-design

# Install dependencies
npm install
# or
pnpm install

# Run development server
npm run dev
# or
pnpm dev

Open http://localhost:3000 to view the site.

Build for Production

# Create optimized production build
npm run build

# Start production server
npm start

πŸ“¦ Deployment

GitHub Pages

This project is configured for automatic deployment to GitHub Pages using GitHub Actions.

Setup Instructions:

  1. Push to GitHub Repository

    git init
    git add .
    git commit -m "Initial commit"
    git remote add origin https://github.com/UltimateMenu/ultimatemenu.github.io.git
    git branch -M main
    git push -u origin main
  2. Enable GitHub Pages

    • Go to your repository settings
    • Navigate to Pages section
    • Under Source, select GitHub Actions
  3. Automatic Deployment

    • The site will automatically build and deploy on every push to main branch
    • GitHub Actions workflow is located in .github/workflows/deploy.yml
    • Build artifacts are uploaded to the gh-pages branch
    • Site will be available at: https://ultimatemenu.github.io

Manual Build for GitHub Pages:

# Build the static site
npm run build

# The output will be in the 'out' directory
# Upload the contents of 'out' to your hosting provider

Vercel

  1. Import your GitHub repository to Vercel
  2. Vercel will auto-detect Next.js and deploy
  3. No additional configuration needed
  4. Site will be available at: https://ultimatemenu.vercel.app

🎨 Customization

OG Meta Tags & Embeds

The site includes comprehensive Open Graph and Twitter Card meta tags:

  • Embed Color: #00FF00 (green theme)
  • Embed Image: 1.png from screenshots
  • Theme Color: Matches the primary green color
  • Discord/Twitter: Rich embeds with image preview

Theme Toggle

  • Animated theme switcher with smooth transitions
  • Icons rotate and scale when switching themes
  • Automatically detects system theme preference
  • Persists user's theme choice

πŸ”§ Configuration

Visitor Counter

The visitor counter uses the free visitor.6developer.com API:

  • No API key required
  • Automatically tracks visits per domain
  • Returns total visit count

GitHub API

Update repository references in:

  • components/stats.tsx - For stars/forks count
  • app/changelog/page.tsx - For release notes

πŸ“„ License

This project is open source and available under the MIT License.

🀝 Contributing

Contributions, issues, and feature requests are welcome!

πŸ“ž Support

πŸ™ Acknowledgments


Β© 2025 UltimateMenu | Built with Next.js, React, and TypeScript

About

Main Showcase site. (the site is and will be open source forever <3)

Resources

License

Stars

Watchers

Forks