This application allows admins and moderators to manage a whitelist for their Minecraft server efficiently. Users can be added and removed from the whitelist by simply clicking a checkbox.
Users register by themselves on the website. The Minecraft options menu inspires the style and guides the user through registration. They can enter their Minecraft username, select their game type (Java and Bedrock Edition), and submit for approval. Then, a registered admin can log in to the admin panel to review all submissions.
This application consists of two parts: A Backend built on Prisma, SQLite, and Express, and a Frontend built on React.
To use all the features, you must have a Paper Minecraft Server running and use MC-Sleeping-Server-Starter, as well as the EmptyServerStopper and EasyWhitelist Plugins.
Please check the dedicated Backend and Frontend README docs for more details.
- Minecraft-style interface
- User registration with Minecraft username and error-checking
- Admin authentication and registration with tokens
- Admin panel for approving or rejecting users and registering new admins
- Automatic Minecraft server whitelist management through RCON
- Server Status when using MC-Sleeping-Server-Starter (recommended)
- Bedrock support with Floodgate integration
- Microsoft Xbox authentication
- Automatically insert users on the first join
- Server statistics, including graphs
- User group management
bash
+----------------------+
| User's Web Browser |
+----------------------+
|
(1) HTTP Request (GET)
|
v
+-----------------------+
| Frontend App |
| (React, React Router)|
+-----------------------+
|
(2) Client-Side Routing (React Router)
|
v
+-----------------------+
| Frontend API |
| (Axios, Fetch, etc.) |
+-----------------------+
|
(3) HTTP Request (GET/POST)
|
v
+----------------------------------+
| Backend Server |
| (Node.js, Express, SQLite, etc.) |
+----------------------------------+
|
(4) Authentication (Passport, JWT, etc.)
|
v
+----------------------------------+
| Session Management |
| (Cookies, Express-Session, etc.) |
+----------------------------------+
|
(5) HTTP Request (GET/POST)
|
v
+------------------+
| Database |
| (SQLite) |
+------------------+
|
(6) Query Response
|
v
+------------------+
| Backend |
| Data Processing |
+------------------+
|
(7) HTTP Response (JSON)
|
v
+--------------+
| Backend |
| Rendering |
+--------------+
|
(8) HTTP Response (HTML/JS/CSS)
|
v
+----------------+
| User's Browser |
| Rendering |
+----------------+
-
The user's web browser sends an HTTP request (GET) to the website to load the page.
-
The frontend app (React) handles the routing and sends additional HTTP requests (GET/POST) to interact with the backend server.
-
The backend server (Node.js, Express) processes the requests, interacts with the database (SQLite), and sends an HTTP response (JSON) back to the frontend app.
-
The frontend app updates parts of the UI based on the response received from the server.
-
The user's web browser renders the updated UI and makes the website interactive.
Before you begin, ensure you have met the following requirements:
- You have installed Node.js (14.x or later is recommended)
- You have access to a Minecraft server with RCON enabled
- (You have installed MC-Sleeping-Server-Starter on top of your Minecraft server)
Generally, you can follow this guideline. More detailed descriptions are in the dedicated Backend and Frontend README docs.
- Clone this repository:
git clone https://github.com/maxonary/convitelist
cd convitelist- Install the dependencies:
cd backend
npm install
cd ../frontend
npm install- Copy the
.env.examplefiles for Back- and Frontend to.env:
# cd into the folders first
cp .env.example .env-
Update the
.envfile with your SQLite database URL, RCON credentials, and other configuration options. -
Run the database migrations in the backend folder:
cd backend
npx prisma migrate deployor
cd backend
npx prisma migrate dev --name init # for development to create a database- Generate the Prisma ORM
npx prisma generate # for development to create a database- Build the code for production (individually):
npm run build- Start the production server (individually):
npm run startThe backend application will be available at http://localhost:3001
and the frontend application will be available on a free port (normally http://localhost:3000).
The deployment process will depend on your chosen hosting provider. Please consult the provider's documentation for deploying Node.js and React applications and configuring environment variables.
We are following the practice of Trunk Based Development.
This means that all changes are made in the master branch and deployed to production as soon as they are ready.
On each push to master, the application is automatically built and deployed to production using a CI/CD pipeline.
If you want to contribute to this project, please fork the repository and create a pull request. This may not be the best pracitice for Trunk Bases Development, but it is the easiest for us to manage.