Get Template

Quick Setup

Get your Minecraft server homepage running in under 5 minutes.

○Requirements
Node.js 18+ installed on your machine. Download from nodejs.org if needed.
1

Install Dependencies

Open your terminal, navigate to the template folder, and run:

npm install

This downloads all the required packages. Takes about 30 seconds.

2

Configure Your Server

Open src/config/site.config.ts in any text editor. Find the server section at the top:

src/config/site.config.ts
server: {
  name: 'YourServerName',
  tagline: 'Your epic tagline here',
  description: 'A longer description of your server...',
  ip: 'play.yourserver.com',
  version: '1.20.4',
  port: 25565,
}

Replace the values with your server's information. Save the file.

3

Start Development Server

Run the development server to see your changes live:

npm run dev

Open http://localhost:3000 in your browser. You'll see your homepage with your server name.

✓Hot Reload Enabled
Any changes you make to the config file will instantly appear in your browser without refreshing.
4

Build for Production

When you're happy with your site, build it for production:

npm run build

This creates an out folder with static HTML, CSS, and JS files. Upload this folder to any web host.

Common Commands

npm install

Install all dependencies

npm run dev

Start development server

npm run build

Build for production

out/

Production files location

Next Steps