README
¶
Kleister: API server
Kleister is a web UI to manage mod packs for the Minecraft, initially focused on the Technic Launcher and MCUpdater. Even if there is an upstream version available the Technic Launcher at TechnicPack/TechnicSolder I prefered to implement it in Go for the API and VueJS for the UI including some further features like uploading the mods I want to manage and even generating docker images directly out of the managed packs. Hosting Minecraft servers based on docker images works pretty cool.
Install
You can download prebuilt binaries from the GitHub releases or from our download site. If you prefer to use containers you could use our images published on Docker Hub or Quay. You are a Mac user? Just take a look at our homebrew formula. If you need further guidance how to install this take a look at our documentation.
Development
Make sure you have a working Go environment, for further reference or a guide take a look at the install instructions. This project requires Go >= v1.23.1, at least that's the version we are using.
git clone https://github.com/kleister/kleister-api.git
cd kleister-api
make generate build
./bin/kleister-api -h
Security
If you find a security issue please contact kleister@webhippie.de first.
Contributing
Fork -> Patch -> Push -> Pull Request
Authors
License
Apache-2.0
Copyright
Copyright (c) 2018 Thomas Boerger <thomas@webhippie.de>
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
pkg
|
|
|
api/v1
Package v1 provides primitives to interact with the openapi HTTP API.
|
Package v1 provides primitives to interact with the openapi HTTP API. |
|
service/build_versions
Package buildversions is a generated GoMock package.
|
Package buildversions is a generated GoMock package. |
|
service/builds
Package builds is a generated GoMock package.
|
Package builds is a generated GoMock package. |
|
service/fabric
Package fabric is a generated GoMock package.
|
Package fabric is a generated GoMock package. |
|
service/forge
Package forge is a generated GoMock package.
|
Package forge is a generated GoMock package. |
|
service/minecraft
Package minecraft is a generated GoMock package.
|
Package minecraft is a generated GoMock package. |
|
service/mods
Package mods is a generated GoMock package.
|
Package mods is a generated GoMock package. |
|
service/neoforge
Package neoforge is a generated GoMock package.
|
Package neoforge is a generated GoMock package. |
|
service/packs
Package packs is a generated GoMock package.
|
Package packs is a generated GoMock package. |
|
service/quilt
Package quilt is a generated GoMock package.
|
Package quilt is a generated GoMock package. |
|
service/team_mods
Package teammods is a generated GoMock package.
|
Package teammods is a generated GoMock package. |
|
service/team_packs
Package teampacks is a generated GoMock package.
|
Package teampacks is a generated GoMock package. |
|
service/teams
Package teams is a generated GoMock package.
|
Package teams is a generated GoMock package. |
|
service/user_mods
Package usermods is a generated GoMock package.
|
Package usermods is a generated GoMock package. |
|
service/user_packs
Package userpacks is a generated GoMock package.
|
Package userpacks is a generated GoMock package. |
|
service/user_teams
Package userteams is a generated GoMock package.
|
Package userteams is a generated GoMock package. |
|
service/users
Package users is a generated GoMock package.
|
Package users is a generated GoMock package. |
|
service/versions
Package versions is a generated GoMock package.
|
Package versions is a generated GoMock package. |
|
store
Package store is a generated GoMock package.
|
Package store is a generated GoMock package. |
|
upload
Package upload is a generated GoMock package.
|
Package upload is a generated GoMock package. |