koconutmc.com Website

This project is the front-end source code for the Koconut MC modpack and Koconut SMP.

Development

Prerequisite: a node package manager such as npm

cd website
npm install

For development:

npm run dev

For production testing:

npm run build
npm run preview # start a web server for TESTING purposes

Adding images to the gallery:

The project recommends converting lossless to lossy webp images with a quality preset of 90% for the images gallery (/public/gallery).

ffmpeg -i input.png -q:v 90 compressed_output.webp

The image naming format is <title>_<author>.webp.

Deployment

This is the recommended way for production use.

Prerequisites: docker and docker-compose

A docker-compose.yml is provided by the project for easy deployment. The compose stack uses crafatar API to retrieve player avatar images, the API also requires redis.

The web map uses Bluemap which is also included in the compose stack, it is highly recommended to consult BlueMap's documentation for configuring a Minecraft world to use and its modpack resources before deploying.

Deploying the compose manually:

cd website
mkdir modpack # the volume that holds large sized modpack files for downloading off the web
docker compose up -d # before deploying the compose stack, it is recommended to read the compose first

License

^{Licensed under LGPL-3.0 License.}