Minecraft server status

Shows the status of a minecraft server.

For demonstration I use as default my own minecraft server.

This app is online under mc-status.inpercima.net.

This project was generated with swaaplate version 2.5.3.

Prerequisites

Angular CLI

• @angular/cli 17.3.7 or higher

Node, npm or yarn

• node 20.9.0 or higher in combination with
  • npm 10.1.0 or higher or
  • yarn 1.22.19 or higher, used in this repository

Getting started

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

# install tools and frontend dependencies
yarn

Create environment files for development mode and production mode.

cp src/environments/environment.ts src/environments/environment.dev.ts
cp src/environments/environment.ts src/environments/environment.prod.ts

Note: These files will not be under version control but listed in .gitignore.

Usage

Recommendation

It is recommanded to use a server to get full access of all angular. For the other options your app should run on a server which you like.

Run in development mode

# build, reachable on http://localhost/app/path/to/dist/
yarn build:dev

# build and starts a server, rebuild after changes, reachable on http://localhost:4200/
yarn serve:dev

# build, rebuild after changes, reachable on http://localhost/app/path/to/dist/
yarn watch:dev

Package

# build in production mode, compressed
yarn build:prod

Tests

# test
ng test

# e2e
ng e2e

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
• defaultRoute
• 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

defaultRoute

The default route and the route to be redirected after a login if no route is stored or if a route does not exist.

• default: dashboard
• type: string

production

Defines whether the app is in production or not.

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

theme

Name of a build-in theme from angular-material or a custom light or dark theme.

• default: indigo-pink
• type: string
• values: deeppurple-amber/indigo-pink/pink-bluegrey/purple-green/custom-light/custom-dark

To create a custom light or dark 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.