Minecraft server status

Shows the status of a minecraft server.

For demonstration I use as default my own minecraft server.

This app is available at mc-status.inpercima.net.

Prerequisites

Node, npm or pnpm

• node 24.16.0 or higher in combination with
  • npm 11.13.0 or higher or
  • pnpm 10.34.4 or higher, used in this repository

Install pnpm by running:

npm install -g pnpm@10.34.4

Info for npm and pnpm

This repo uses pnpm as package manager. You can also use npm for your local work but changes will be made by pnpm only.

Angular CLI

• @angular/cli 22.0.7 or higher

Install @angular/cli by running:

pnpm install -g @angular/cli@212

Getting started

# clone project
git clone https://github.com/inpercima/mc-status

# navigate to project
cd mc-status

# install tools and frontend dependencies
pnpm install

# create environment files for `development mode`.
cp src/environments/environment.ts src/environments/environment.dev.ts

Note: This file will not be under version control (listed in .gitignore).

Development Mode

Setup for development

Edit src/environments/environment.dev.ts to match your local setup:

• Set production: false
• Configure api URL (default: ./)
• Adjust other settings as needed (see Configuration section)

Running in development mode

pnpm start

The application will be available at http://localhost:4200/ and automatically reload when you make changes to the source code.

Building for development

pnpm build:dev

This runs ng lint followed by ng build --configuration=development, creating a development build in the dist/ directory.

Production Mode

Setup for production

Edit src/environments/environment.prod.ts:

• Set production: true
• Configure production api URL
• Set appropriate theme and other production-specific settings

Building for production

pnpm build:prod

This runs ng lint followed by ng build (production configuration), creating an optimized bundle in dist/browser/.

Deployment

The app did not have a specified version. After a push to the main branch the app will be deployed by the github actions using github pages.

Testing and linting

# run unit tests
ng test

# run end-to-end tests
ng e2e

# lint files
ng lint

Configuration

General

All options have to been set in the environment files but some of them do not need to be changed. All defaults refer to the environment file (environment.ts), they are prepared in development mode (environment.dev.ts). Change for production mode the option production to true.

Table of contents

• api
• appname
• production
• theme
• serverIp
• serverPort

api

Defines the URL to the backend.

• default: ./
• type: string

appname

Applicationwide title of the app, displayed in title and toolbar.

• default: Minecraft server status
• type: string

production

Defines whether the app is in production or not.

• default: false
• type: boolean
• values: true/false

theme

Name of a pre-build-theme or a custom theme.

• default: rose-red
• type: string
• values: rose-red/azure-blue/magenta-violet/cyan-orange/custom

To modify the custom theme just edit the colors and themes in themes.scss.

serverIp

Default server ip for the minecraft server.

serverPort

Default server port for the minecraft server.