Skip to content

Scraper application that collects the most popular Minecraft server jar files.

License

Notifications You must be signed in to change notification settings

Patrick2562/minecraft-jars-api

Repository files navigation

Minecraft Jars API

This is a scraper application built in NestJS, that collects the most popular Minecraft server jar files and checks for updates from time to time. Files are downloaded and, if necessary, built and then stored. It provides an easy-to-use api that can be easily integrated into other systems.

Supported projects

How to use?

  1. We assume that Docker is installed and you have basic knowledge
  2. Clone the repository
  3. Copy .env.example as .env
  4. Open .env and set the values you need (optional)
  5. Run docker compose up -d
  6. Open http://localhost/api/status/ping to check if it works well

API Documentation

You can find the documentation on Wiki page. (click here)

TODO

  • final tune the api / responses
  • redis cache
  • rate limiting
  • more configuration options in .env
  • api key auth
  • statistics
  • documentation