Skip to content

Repository files navigation

KukeMC Website

KukeMC Logo

The official portal for KukeMC Minecraft Server, connecting players and the server.

English | 简体中文

Next.js React TypeScript Tailwind CSS License


📖 Introduction

KukeMC Website is the official frontend project for the KukeMC Minecraft Server. It serves not only as an information platform but also as a feature-rich community hub. Through deep integration with the backend API, the website provides comprehensive services ranging from player data queries and server status monitoring to community interactions and consensus management.

This project is built with the latest Next.js 16 (App Router) architecture, combined with Tailwind CSS 4 and Framer Motion, dedicated to providing players with a smooth, modern, and responsive user experience.


✨ Features

🌐 Community Hub

  • Activity Plaza: Players can post updates, share game screenshots, and interact via likes and comments.
  • News & Announcements: Timely updates on server changes, event notifications, and maintenance schedules.
  • Consensus System: A democratic proposal management system where players can initiate proposals and vote to decide the server's development direction.
  • Message Board: An open space for communication among players.

📊 Game Data Visualization

  • Player Profile: Displays player information, skin previews, game statistics, and achievement levels.
  • Leaderboard: Multi-dimensional player data rankings to inspire healthy competition.
  • Ban List: Public display of violation records to maintain a fair gaming environment.
  • KitBattle: Dedicated data display and rankings for the KitBattle game mode.

🛠️ Utilities & Services

  • Server Monitor: Real-time display of online player count, TPS status, and historical trends.
  • Skin Management: Convenient skin upload and preview functionality.
  • Ticket System: A dedicated channel for players to report issues and seek help.
  • Account Verification: Verification service to bind game accounts with website accounts.

🏗️ Tech Stack

Core

Styling & Animation

Data & State

Editor & Content

  • Rich Text Editor: Tiptap (Headless wrapper around ProseMirror)
  • Markdown: markdown-it, katex (Math support)

🚀 Getting Started

Prerequisites

  • Node.js: >= 18.17.0 (LTS recommended)
  • Package Manager: npm, yarn, pnpm, or bun

Installation

  1. Clone the repository

    git clone <repository-url>
    cd KukeMC-Website/KukeMC-WebSite
  2. Install dependencies

    npm install
    # or
    yarn install
    # or
    pnpm install
  3. Start development server

    npm run dev

    Open http://localhost:3000 to view it in the browser.

  4. Build for production

    npm run build
    npm start

⚠️ Notes

  • API Connection: This project relies on a backend API service. The default Base URL is https://api.kuke.ink/.
  • Local Development: Due to backend API authentication and CORS restrictions, some features involving user data may not work fully in a local environment. It is recommended to focus on UI/UX development and static page debugging locally.
  • Deployment: We recommend deploying on Vercel or using traditional Node.js hosting (PM2).

📂 Project Structure

KukeMC-WebSite/
├── public/              # Static assets (images, icons, etc.)
├── src/
│   ├── app/             # Next.js App Router pages & routes
│   ├── components/      # React components
│   │   ├── next/        # Business-specific components
│   │   └── ui/          # Generic UI components
│   ├── context/         # React Context (Auth, Theme, etc.)
│   ├── services/        # API service wrappers
│   ├── types/           # TypeScript type definitions
│   └── utils/           # Utility functions
├── next.config.mjs      # Next.js configuration
├── tailwind.config.js   # Tailwind CSS configuration
└── package.json         # Project dependencies & scripts

🤝 Contributing

We appreciate all developers who contribute to KukeMC!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📄 License

Distributed under the MIT License.


🔗 Links

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages