Giter VIP home page Giter VIP logo

msmf's Introduction

Minecraft Server Management Framework

This framework will be a web management portal for creating, configuring, and managing Minecraft servers.

Quickstart

To get started, copy the .env-template file over to .env. Next, change all of the passwords in the .env to ones you like.

Production

For users in production, run the following

docker-compose up --build -d

The portal will be located at http://localhost

If you would like to stop the application, just run

docker-compose stop

Development

For those wishing to help develop, run

docker-compose -f docker-compose.dev.yml up --build -d && docker logs --follow --since 10s msmf_dev

The portal can be accessed on http://localhost:8080

This will spin up containers that will live reload any changes made to both the front end and backend.

In addition, for help debugging the database, a pgAdmin instance will be located at http://localhost:5050. The credentials for it are the ones set in the .env file

TODO

  • Default admin account where the user sets the password
  • Login functionality
  • Change passwords
  • Referral system to allow other users to join the portal
  • Permission checking
  • Permission management system
  • Server creation
  • Server configuration interface
  • Server management
  • Account settings
  • Linking player accounts with user accounts
  • Server auto backup functionality
  • Server auto update functionality
  • Add let's encrypt support

msmf's People

Contributors

stew3254 avatar yttrian avatar

Stargazers

 avatar Christopher Mahoney avatar  avatar GAURAV avatar  avatar

Watchers

James Cloos avatar  avatar  avatar

Forkers

spud304

msmf's Issues

Implement user registration interface

As an invite game server manage, I want to register an account, so I have a user account.

A skeleton currently exists. Just need to implement the functionality to use the form.

Requirements

  • Useable user registration form
  • Explain how to ask for a referral code
  • Indicate successful registration
  • (Maybe) redirect to login when registered

Create interface for modifying an existing server

As a game server manager, I want to be able to modify an existing server, so that it matches my needs.

Requirements

  • Ability to rename server
  • Ability to change port
  • Ability to change game version
  • Success indicator

Require users to login before interacting with routes requiring authorization

As a game server manager, I want it to be made clear that I need to login, so that I can use routes that require authorization.

Currently users can visit pages like "New Server" without being logged in. This is confusing because when they try to use the form they will get the following error:

Unexpected token u in JSON at position 4

These routes should be hidden from navigation if not logged in, and the user should be sent to the login page if trying to visit these routes.

Requirements

  • Hide routes requiring authorization from nav
  • Redirect users trying to visit authorized routes when not logged to login
  • Either show useful errors if auth expired after reaching a route or redirect

Create interface for managing referral codes

As a game server manager, I want to be able to create referral codes, so that I can easily invite new members.

Requirements

  • Ability to generate
  • Ability to list existing
  • Ability to delete? (if exists on backend)

Create interface for deleting a server

As a game server manager, I want to be able to delete a server, so that it no longer exists.

Requirements

  • Indicate required permissions
  • Confirm deletion with user
  • Warn about consequences

Implement change password interface

As a game server manager, I want to be able to change my password, so that I can use a different password.

Requirements

  • Indicate successful change
  • Notify user when passwords do not match
  • (Optional) Warn about insecure passwords

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.