mhsf-dev/README.md

32 lines
1.6 KiB
Markdown
Raw Normal View History

2024-07-26 00:46:53 -05:00
<img src="https://i.imgur.com/H7GhfNM.png" align="center">
2024-08-08 21:34:27 -05:00
<h1 align="center">MHSF</h1>
2024-05-31 16:22:34 -05:00
2024-11-10 10:55:28 -06:00
An open-source customizable server-list for Minehut built in React. Check it out at [list.mlnehut.com](https://mhsf.app), and maybe give this repo a star! :)
2024-08-08 21:34:27 -05:00
> [!WARNING]
> If you want more of a explanation what this is, please use the built-in info popover. This README is mostly for contributing. Thanks!
2024-05-31 16:22:34 -05:00
2024-08-11 14:16:08 -05:00
## Info
2024-08-12 12:47:20 -05:00
2024-08-11 14:16:08 -05:00
![Alt](https://repobeats.axiom.co/api/embed/0ee8fb5584604adac02f04cff49f1091af45c3a8.svg "Repobeats analytics image")
2024-07-23 18:49:21 -05:00
## Tech-stack
2024-05-31 16:22:34 -05:00
2024-07-23 20:51:32 -05:00
[React](https://react.dev): Component based syntaxing for the web <br/>
2024-07-26 00:46:53 -05:00
[Next.js](https://nextjs.org): Handles API, server-based metadata, and so much more.<br/>
2024-07-23 20:51:32 -05:00
[Clerk](https://clerk.com): Authentication for MHSF (very cool library) <br/>
[TailwindCSS](https://tailwindcss.com): Styling without CSS, simplified<br/>
[shadcn/ui](https://ui.shadcn.com): Provides the awesome UI for MHSF<br/>
And many other smaller libraries are in use to make sure MHSF is feature-packed.<br/>
2024-05-31 16:22:34 -05:00
2024-07-23 18:49:21 -05:00
## Contributing
2024-08-12 12:47:20 -05:00
2024-08-08 21:34:27 -05:00
> [!NOTE]
> Do you use Java and not JavaScript/TypeScript? You can also contribute to [MHSFPV (Minehut Server List Player Validator)](https://github.com/DeveloLongScript/MHSFPV), a player validator plugin to link accounts. It's relatively small, but can use commits.
2024-05-31 16:22:34 -05:00
2024-09-12 16:01:57 -05:00
The contributing guide is [here](https://github.com/DeveloLongScript/MHSF/blob/main/CONTRIBUTING.md).
2024-08-12 12:47:20 -05:00
2024-08-08 21:34:27 -05:00
## Licensing
2024-08-12 12:47:20 -05:00
2024-09-12 17:18:17 -05:00
MHSF (aka the Minehut Server List) is licensed under the [MIT License](https://github.com/DeveloLongScript/MHSF/blob/main/LICENSE). You are free to fork or modify this software *on your own terms*.