Modrinth/apps/app/README.md
2024-07-04 21:46:29 -07:00

30 lines
1.0 KiB
Markdown

# ![Modrinth App](/.github/assets/app_cover.png)
## Modrinth App
The Modrinth App is a desktop application for managing your Minecraft mods. It is built with [Tauri](https://tauri.app/) and [Vue](https://vuejs.org/).
If you're not a developer and you've stumbled upon this repository, you can download the latest release of the app from the [Modrinth website](https://modrinth.com/app).
## Development
### Pre-requisites
Before you begin, ensure you have the following installed on your machine:
- [Node.js](https://nodejs.org/en/)
- [pnpm](https://pnpm.io/)
- [Rust](https://www.rust-lang.org/tools/install)
- [Tauri](https://tauri.app/v1/guides/getting-started/prerequisites/#installing)
### Setup
Follow these steps to set up your development environment:
```bash
pnpm install
cargo tauri dev # `pnpm app:dev` is currently broken, contributions welcome!
```
You should now have a development build of the app running with hot-reloading enabled. Any changes you make to the code will automatically refresh the app.