https://github.com/joshmerlino/omnispigot

An API server for caching and distributing Minecraft Server JARs.
https://github.com/joshmerlino/omnispigot

Last synced: about 1 month ago
JSON representation

An API server for caching and distributing Minecraft Server JARs.

• Host: GitHub
• URL: https://github.com/joshmerlino/omnispigot
• Owner: JoshMerlino
• Created: 2021-09-22T01:01:37.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-09-15T15:33:25.000Z (over 1 year ago)
• Last Synced: 2024-05-29T19:12:30.773Z (8 months ago)
• Language: TypeScript
• Homepage:
• Size: 5.23 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# omninspigot

### Checks

* [![Code Style Analysis](https://github.com/JoshMerlino/omnispigot/actions/workflows/code-style-analysis.yml/badge.svg)](https://github.com/JoshMerlino/omnispigot/actions/workflows/code-style-analysis.yml)

* [![Code Quality Analysis](https://github.com/JoshMerlino/omnispigot/actions/workflows/code-quality-analysis.yml/badge.svg)](https://github.com/JoshMerlino/omnispigot/actions/workflows/code-quality-analysis.yml)

* [![Test CI](https://github.com/JoshMerlino/omnispigot/actions/workflows/test-ci.yml/badge.svg)](https://github.com/JoshMerlino/omnispigot/actions/workflows/test-ci.yml)

An API server for caching and distributing Minecraft Server JARs.

## Run the server yourself

```batch

git clone https://github.com/JoshMerlino/omnispigot.git

cd omnispigot

sudo apt-get install build-essential -y

npm install

npm run build

```

Then run the server with: `node .`

## API Documentation

Run the server with the instructions above, then navigate to `https://localhost/docs/` for the automaticly generated documentation.