mhsf-dev/README.md

# MHSF

An open-source Minehut server viewer/finder made in React + Next.js. Is much better than the Minehut one, as has many filters and is improving everyday.

## 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.

## Contributing

If you'd like to contribute, you must follow the guidelines below:

- Make sure to lint (`npm run lint`) every time you finish lines of code
- Use common sense! Don't make comments that could offend someone, or just seems like a bad ideaa
- Be respectful when making your PR. We would love to take your code, but if you argue, it doesn't help.

## Building

Clone the repo!

First, you must supply the following services with API keys:

- [Clerk](https://clerk.com): Create an app and put the respective keys in `.env.local`

Second, run `npm i` and `npm run build`. To start the app, run `npm run start`.

### Dev

Swap `npm run build` for `npm run dev`.
feat: inital commit 2024-07-23 18:49:21 -05:00			`# MHSF`
Initial commit from Create Next App 2024-05-31 16:22:34 -05:00
feat: inital commit 2024-07-23 18:49:21 -05:00			`An open-source Minehut server viewer/finder made in React + Next.js. Is much better than the Minehut one, as has many filters and is improving everyday.`
Initial commit from Create Next App 2024-05-31 16:22:34 -05:00
feat: inital commit 2024-07-23 18:49:21 -05:00			`## Tech-stack`
Initial commit from Create Next App 2024-05-31 16:22:34 -05:00
feat: inital commit 2024-07-23 18:49:21 -05:00			`[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.`
Initial commit from Create Next App 2024-05-31 16:22:34 -05:00
feat: inital commit 2024-07-23 18:49:21 -05:00			`## Contributing`
Initial commit from Create Next App 2024-05-31 16:22:34 -05:00
feat: inital commit 2024-07-23 18:49:21 -05:00			`If you'd like to contribute, you must follow the guidelines below:`
Initial commit from Create Next App 2024-05-31 16:22:34 -05:00
feat: inital commit 2024-07-23 18:49:21 -05:00			- Make sure to lint (`npm run lint`) every time you finish lines of code
			`- Use common sense! Don't make comments that could offend someone, or just seems like a bad ideaa`
			`- Be respectful when making your PR. We would love to take your code, but if you argue, it doesn't help.`
Initial commit from Create Next App 2024-05-31 16:22:34 -05:00
feat: inital commit 2024-07-23 18:49:21 -05:00			`## Building`
Initial commit from Create Next App 2024-05-31 16:22:34 -05:00
feat: inital commit 2024-07-23 18:49:21 -05:00			`Clone the repo!`
Initial commit from Create Next App 2024-05-31 16:22:34 -05:00
feat: inital commit 2024-07-23 18:49:21 -05:00			`First, you must supply the following services with API keys:`
Initial commit from Create Next App 2024-05-31 16:22:34 -05:00
feat: inital commit 2024-07-23 18:49:21 -05:00			- [Clerk](https://clerk.com): Create an app and put the respective keys in `.env.local`
Initial commit from Create Next App 2024-05-31 16:22:34 -05:00
feat: inital commit 2024-07-23 18:49:21 -05:00			Second, run `npm i` and `npm run build`. To start the app, run `npm run start`.
Initial commit from Create Next App 2024-05-31 16:22:34 -05:00
feat: inital commit 2024-07-23 18:49:21 -05:00			`### Dev`
Initial commit from Create Next App 2024-05-31 16:22:34 -05:00
feat: inital commit 2024-07-23 18:49:21 -05:00			Swap `npm run build` for `npm run dev`.