modrinth-code/apps/app/README.md

30 lines
936 B
Markdown
Raw Permalink Normal View History

2024-07-04 21:46:29 -07:00
# ![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://v2.tauri.app/start/prerequisites/)
2024-07-04 21:46:29 -07:00
### Setup
Follow these steps to set up your development environment:
```bash
pnpm install
pnpm app:dev
2024-07-04 21:46:29 -07:00
```
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.