The end-goal is to have a feature-rich management panel for VORP-based servers. Right now, only a few features exist, but the todo list is too long to bother writing here.
As of now:
- Item creation/updating
- Viewing basic user stats
In the future: (not an exhaustive list)
- Editing users and characters
- Heatmaps
- Log viewing
- Other various analytics
- Clone the repository.
- Copy
.env.exampleto.envand add your MySQL Connection String to theDATABASE_URLvariable - Install dependencies:
yarn install - Start the project:
yarn dev
- Copy
.env.exampleto.envand add your MySQL Connection String to theDATABASE_URLvariable - Install dependencies:
yarn install - Run
yarn build
- Copy
.env.exampleto.envand add your MySQL Connection String to theDATABASE_URLvariable - Install dependencies:
yarn install - Build:
yarn build - Start the server:
yarn start
- Copy
.env.exampleto.envand add your MySQL Connection String to theDATABASE_URLvariable - Run
docker compose -f "compose.yaml" up -d --build
All API endpoints are protected behind Discord authentication. In your .env file that you set up in the instructions above, you'll need to also set up a Discord application and under OAUTH2, copy the CLIENT ID and CLIENT SECRET into your .env file as well. Authentication is based on Discord roles, so users in your Discord server with a particular role will be able to log into the panel. You'll need to copy your Discord server ID and the role ID you want to use into your .env file.
In your Discord Developer Portal where you got the OAUTH2 Client ID and Client Secret, you'll need to add the following redirect URI:
http://localhost:3000/api/auth/callback/discord
Make sure to change the http://localhost:3000 to whatever URL you're using.
Pull requests are welcome. Please ensure that your changes lint and build successfully.