Skip to content

README.en.md

Latest commit

 

History

History
70 lines (47 loc) · 2.14 KB

README.en.md

File metadata and controls

70 lines (47 loc) · 2.14 KB
Raw

EndlessPixel Web

Next.js TypeScript Tailwind CSS License

English | 简体中文

Official website of EndlessPixel Server, built with Next.js App Router + TypeScript + Tailwind CSS.

✨ Features

  • ⚡ Next.js 16 full-stack React framework, SSR/SSG/ISR ready
  • 🎨 Tailwind CSS 4 utility-first, dark-mode out of the box
  • 📦 80+ launchers & mod-packs high-speed download, custom mirror support
  • 🧪 Strict TypeScript checking, ESLint + Prettier automated
  • 📱 Responsive layout, PWA offline support (Workbox auto-generated)

🚀 Quick Start

Prerequisites

  • Node.js ≥ 18
  • npm ≥ 9

Local Development

# 1. Clone repo
git clone https://github.com/EndlessPixel/server.git
cd server

# 2. Install dependencies
npm install

# 3. Start dev server
npm run dev
# or npm run dev-https

Visit http://localhost:3000 or https://localhost:3000in your browser.

🤝 Contributing

  1. Fork the repository
  2. Create feature branch: git checkout -b feat/xxx
  3. Commit: git commit -m "feat: add xxx" (follow Conventional Commits)
  4. Push and open a Pull Request
  5. Merge after CI & code review

Code Style

  • TypeScript strict mode on
  • Prefer Tailwind CSS, avoid inline styles
  • Run npm run lint && npm run type-check before commit

📄 License

GNU Affero General Public License v3.0
Commercial use, modification and redistribution are allowed, but modified network services must be open-sourced.

💬 Get in Touch

Star ⭐ and Watch 👀 are the best supports for us!