Info: Source Code

Source Code

The source code can be found here.

Installation

Requires Node.js and npm

npm install or yarn

Running the application

npm run start or yarn start

The app should be available at port 3000.

Brief walkthrough of the source code

HyMinions is built on ExpressJS.

The pages are located under /templates/views. Pug.js is used instead of HTML.

The controllers that render the pages can be found under /routes/views.

The main logic under each page can be found under /routes/api.

Files with constants on minions and forge items can also be found in /routes/api.

You will need to create a .env file, containing a random string labelled COOKIE_SECRET, and your Hypixel API key labelled HYPIXEL_KEY.

The forge page would not work properly because a link to my own backend server is required. However, it will not be shared with you because it is not a free service. Use my API to access information on the forge page. Sorry for the inconvenience.

Guidelines

Pull requests are welcome.
You could also fork the code on GitHub to make your own copy of the project.
Citing the name of my website - HyMinions, and includes a link to HyMinions in your own application is appreciated, but not necessary.
If you would like me to add a link to it on HyMinions, it has to follow the following rules for me to consider:
- It cites the name of my website - HyMinions, and including a link to HyMinions.
- It is free to use and ad-free.; OR There is some way for me to share part of the revenue.
- Contact me for exact details and I will asset on a case-by-case basis.

License

This work is licensed under the MIT license.

Feel free to contact me if you find any of this unclear.