From fbab3e4676cd68d78de647fa4f1d1dae48f792a4 Mon Sep 17 00:00:00 2001 From: dvelo <52332868+DeveloLongScript@users.noreply.github.com> Date: Wed, 26 Mar 2025 18:53:08 -0500 Subject: [PATCH] feat(git): up to date w/ main --- .idea/copyright/MIT_License_f__MHSF.xml | 2 +- .idea/copyright/profiles_settings.xml | 2 +- LICENSE | 21 +++++++++++++++++++ README.md | 27 +++++++++---------------- SECURITY.md | 26 ++++++++++++++++++++++++ biome.json | 18 ----------------- package.json | 4 ++-- yarn.lock | 4 ++-- 8 files changed, 62 insertions(+), 42 deletions(-) create mode 100644 LICENSE create mode 100644 SECURITY.md delete mode 100644 biome.json diff --git a/.idea/copyright/MIT_License_f__MHSF.xml b/.idea/copyright/MIT_License_f__MHSF.xml index 77536ee..e2c2071 100644 --- a/.idea/copyright/MIT_License_f__MHSF.xml +++ b/.idea/copyright/MIT_License_f__MHSF.xml @@ -1,6 +1,6 @@ - \ No newline at end of file diff --git a/.idea/copyright/profiles_settings.xml b/.idea/copyright/profiles_settings.xml index 2ebca56..cf3cce4 100644 --- a/.idea/copyright/profiles_settings.xml +++ b/.idea/copyright/profiles_settings.xml @@ -1,5 +1,5 @@ - + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5247c92 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 dvelo + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 7338dc3..c9bd71b 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,21 @@ -
-

MHSF

+# ![MHSF Cover](/.github/github-banner.png)
nextjs docs mhsf.app
+## The MHSF Project -An open-source customizable server-list for Minehut built in React. Check it out at [mhsf.app](https://mhsf.app), and maybe give this repo a star! +A modern, third-party Minehut server list that is completely open-source, built using top of the line web technologies. Not built to take your money or time, find a server in minutes. Completely ad-free. -## Info - -![Alt](https://repobeats.axiom.co/api/embed/0ee8fb5584604adac02f04cff49f1091af45c3a8.svg "Repobeats analytics image") - -## Tech-stack - -[React](https://react.dev): Component based syntaxing for the web
-[Next.js](https://nextjs.org): Handles API, server-based metadata, and so much more.
-[Clerk](https://clerk.com): Authentication for MHSF (very cool library)
-[TailwindCSS](https://tailwindcss.com): Styling without CSS, simplified
-[shadcn/ui](https://ui.shadcn.com): Provides the awesome UI for MHSF
-And many other smaller libraries are in use to make sure MHSF is feature-packed.
+## Security +Please privately disclose any security problems with a support email or via GitHub (`Security` tab -> `Report a vulnerability`). ## Contributing -> [!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. +Thank you for taking your time to contribute! +Please make sure you read this guide [here](https://github.com/DeveloLongScript/MHSF/blob/main/CONTRIBUTING.md). -The contributing guide is [here](https://github.com/DeveloLongScript/MHSF/blob/main/CONTRIBUTING.md). +## Support +Make a GitHub issue or contact via email, [`support@mhsf.app`](mailto:support@mhsf.app). ## Licensing diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..dc1fd1b --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,26 @@ +# Security Policy +This is the security notice for MHSF. The policy explains how vulnerabilities should be reported. + +## Reporting a Vulnerability +If you've found a vulnerability, we would like to know so we can fix it before it is released publicly. **Do not open a GitHub issue for a found vulnerability.** + +Send details to either *a)* `support@mhsf.app` or *b)* GitHub Security (`Security` tab -> `Report a vulnerability`) including: + +- the website, page or repository where the vulnerability can be observed +- a brief description of the vulnerability +- optionally the type of vulnerability and any related [OWASP category](https://www.owasp.org/index.php/Category:OWASP_Top_Ten_2017_Project) +- non-destructive exploitation details + +We will do our best to reply as fast as possible. + +## Scope +The following vulnerabilities are not in scope: + +- volumetric vulnerabilities, for example overwhelming a service with a high volume of requests +- reports indicating that our services do not fully align with "best practice", for example missing security headers + +If you aren't sure, you can still reach out via email or direct message. + +--- + +This notice is inspired by the [Python Discord Security Notice](https://www.pythondiscord.com/pages/security-notice/). diff --git a/biome.json b/biome.json deleted file mode 100644 index 9ba4f49..0000000 --- a/biome.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "$schema": "./node_modules/@biomejs/biome/configuration_schema.json", - "linter": { - "rules": { - "style": { - "useTemplate": "off", - "useImportType": "warn" - }, - "suspicious": { - "noExplicitAny": "off", - "noDoubleEquals": "warn" - }, - "complexity": { - "noForEach": "off" - } - } - } -} diff --git a/package.json b/package.json index eb4453e..c611414 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "mhsf-monorepo", + "name": "MHSF-Modern", "private": true, "scripts": { "build": "turbo build", @@ -9,7 +9,7 @@ }, "devDependencies": { "prettier": "^3.5.0", - "turbo": "^2.4.2", + "turbo": "^2.4.4", "typescript": "5.7.3" }, "engines": { diff --git a/yarn.lock b/yarn.lock index 5895f13..7075daa 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3491,7 +3491,7 @@ resolved "https://registry.yarnpkg.com/@types/range-parser/-/range-parser-1.2.7.tgz#50ae4353eaaddc04044279812f52c8c65857dbcb" integrity sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ== -"@types/react-dom@19.0.4", "@types/react-dom@^19", "@types/react-dom@^19.0.3": +"@types/react-dom@^19", "@types/react-dom@^19.0.3": version "19.0.4" resolved "https://registry.yarnpkg.com/@types/react-dom/-/react-dom-19.0.4.tgz#bedba97f9346bd4c0fe5d39e689713804ec9ac89" integrity sha512-4fSQ8vWFkg+TGhePfUzVmat3eC14TXYSsiiDSLI0dVLsrm9gZFABjPy/Qu6TKgl1tq1Bu1yDsuQgY3A3DOjCcg== @@ -3503,7 +3503,7 @@ dependencies: "@types/react" "*" -"@types/react@*", "@types/react@19.0.10", "@types/react@^19", "@types/react@^19.0.8": +"@types/react@*", "@types/react@^19", "@types/react@^19.0.8": version "19.0.10" resolved "https://registry.yarnpkg.com/@types/react/-/react-19.0.10.tgz#d0c66dafd862474190fe95ce11a68de69ed2b0eb" integrity sha512-JuRQ9KXLEjaUNjTWpzuR231Z2WpIwczOkBEIvbHNCzQefFIT0L8IqE6NV6ULLyC1SI/i234JnDoMkfg+RjQj2g==