This web backend is built on the laravel/lumen micro framework.
It handles the requests from gudchalmers/chs-mclink and gudchalmers/chs-mclink-velocity to check and register Minecraft accounts with a student email, it shares a token to auth the systems.
When trying to access the api without the shared token or any other url a default page is displayed.
It stores a hashed version of the email that it sent the verification email to along with the Minecraft UUID.
- PHP >= 7.2
- OpenSSL PHP Extension
- PDO PHP Extension
- Mbstring PHP Extension
- A MySQL server
- A way to send emails
- Composer
- Apache (If running Nginx have a look at this)
First install all the dependencies.
composer install --optimize-autoloader --no-devThen rename the .env.example to .env and fill it in with your information.
A note on the APP_KEY value from the Lumen setup:
The next thing you should do after installing Lumen is set your application key to a random string. Typically, this string should be 32 characters long. The key can be set in the .env environment file. If you have not renamed the .env.example file to .env, you should do that now. If the application key is not set, your user encrypted data will not be secure!
The TOKEN value is the shared key with for gudchalmers/chs-mclink and gudchalmers/chs-mclink-velocity.