Skip to content

EasyMinecraftServer/EasyMinecraftServerAPI

Repository files navigation


Logo

EasyMinecraftServerAPI

A FastAPI application to download JAR files

Explore the docs »

View Demo Report Bug Request Feature

About The Project

EasyMinecraftServer's configure command being used to create a settings file in the users home directory

This is a simple project that lets you create Minecraft Server with ease. This API handles the serving of JARs and configuration files. It is being used for EasyMinecraftServer and you can use it in your own projects as long as you notify me of such usage.

Built With

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • Poetry (Linux)
    curl -sSL https://install.python-poetry.org | python3 -
  • Poetry (Windows)
    (Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -

Installation

  1. Clone the repo

    git clone https://github.com/EasyMinecraftServer/EasyMinecraftServerAPI.git
  2. Activate Virtual Enviroment

    Bash / Zsh / Csh

    eval $(poetry env activate)

    Fish

    eval (poetry env activate)
  3. Install dependencies

    poetry install
  4. Run the web server

    fastapi run

Roadmap

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

All commits must follow the Conventional Commits specification and any version bumps must follow the SemVer specification

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the AGPLv3 License. See AGPLv3 License for more information.

Contact

Rüzgar Engür - @nucceteere.xyz - [email protected]

Project Link: GitHub

Acknowledgments

About

No description or website provided.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages