Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 2.13 KB

README.md

File metadata and controls

66 lines (43 loc) · 2.13 KB
Raw

🐭️ MouseHunt Guides, Tools, and Resources - mouse.rip

Discord MIT License Build status

📖 About

This is the repository powering mouse.rip, powered by Next.js and Tailwind.

🚀 Getting Started

First, clone the project locally:

  git clone https://github.com/MHCommunity/mouse.rip.git mouse-rip

Next, change to the project directory

  cd mouse-rip

Install the dependencies

  npm install

Finally, run the development server:

  npm run dev

This will make your site accessible at http://localhost:3000, and will automatically reload when you make changes.

When you're finished, you can check for any errors with:

  npm run lint

If you're happy with your changes, you can submit a Pull Request!

🗒️ Updating the content

  • The Tools, Userscripts, and Spreadsheets lists are generated from the JSON files in the data directory.
  • Redirects are handled in next.config.js.

If you're not familar with Git or the command line and want to make a change to these, you can edit and open a Pull Request directly on GitHub by clicking the "Edit this file" button on the page.

💬 Discussion & Feedback

If you'd like to suggest a change, you can open an issue or a pull request. If you aren't comfortable or familiar with GithHub, or if you have any questions, you can chat in the #community-tools channel on the MouseHunt Community Discord server.

📝 License

This project is licensed under the MIT License.