An open API service indexing awesome lists of open source software.

https://github.com/docimin/cloudnet-webinterface

CloudNet V4 Webinterface - WIP
https://github.com/docimin/cloudnet-webinterface

cloudnet cloudnet-v4 cloudnetservice minecraft webinterface

Last synced: about 1 month ago
JSON representation

CloudNet V4 Webinterface - WIP

Awesome Lists containing this project

README

          

# Cloudnet Webinterface


CloudNet is a modern application that can dynamically and easily deliver Minecraft oriented software.

# Supported Versions

The current supported cloudnet versions. If your version is not supported, please upgrade to the newest one.

| Version | Supported |
| ------- | ------------------ |
| RC-14 | :white_check_mark: |
| RC-13 | :white_check_mark: |
| RC-12 | :white_check_mark: |
| RC-11 | :white_check_mark: |
| RC-10 | :x: |

## My dashboard is empty

You forgot to give yourself permissions. Create a user by following these simple steps:

1. Install the "CloudNet-Rest" module using `modules install CloudNet-Rest` in your CloudNet console.
2. Create a new user with the `rest user create ` command in your CloudNet console. (Example: `rest user create notch foobar`, will create user "notch" with password "foobar")
3. Assign the required permissions using `rest user add scope global:admin` in your CloudNet console. (Example: `rest user notch add scope global:admin` will grant user "notch" admin permissions on your web interface)
4. If the webinterface is started, log in with the username and password you just created.

## Getting Started

Make sure you have pnpm installed using:

```bash
npm i -g pnpm
```

First, install the packages using:

```bash
pnpm install
```

To start the server, use the following command:

```bash
pnpm run dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

## Testing

This project includes Jest and React Testing Library for testing. To run tests:

```bash
pnpm test
```

To run tests in watch mode:

```bash
pnpm run test:watch
```

Tests are located in the `src/__tests__` directory.

## .env

Want to host the website yourself?

Copy .env.example to .env and change `NEXT_PUBLIC_DOMAIN` to your own domain (including http or https).

## Pre-fill CloudNet address

So you want to fill in your user/pass without the address every single time?

Fill in `NEXT_PUBLIC_CLOUDNET_ADDRESS` in your .env file, like for example: `NEXT_PUBLIC_CLOUDNET_ADDRESS=127.0.0.1:2812`, this will autofill it for you.

If you want to use a domain: `NEXT_PUBLIC_CLOUDNET_ADDRESS=https://cloudnet.example.com`.

## Bugs may occur!

Meaning if you encounter any issues, please open up an issue. You are welcome to contribute to this project and create a PR.