Skip to content
This repository was archived by the owner on Oct 19, 2024. It is now read-only.

Add notes to contributing docs to help initial setup #130

Merged
merged 1 commit into from
Oct 4, 2023
Merged

Add notes to contributing docs to help initial setup #130

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,8 @@ If you're prepared to contribute by submitting a pull request, ensure you have m
- `cargo check` has been run.
- `cargo sqlx prepare` has been run.

> Note: If you encounter issues with `sqlx` saying 'no queries found' after running `cargo sqlx prepare`, you may need to ensure the installed version of `sqlx-cli` matches the current version of `sqlx` used [in labrinth](https://github.com/modrinth/labrinth/blob/master/Cargo.toml).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this is really the proper solution, but it's what got cargo sqlx prepare to work for me (based on launchbadge/sqlx#788 (comment))


### knossos (frontend)

[knossos] is the Nuxt.js frontend. You will need to install [pnpm] and run the standard commands:
Expand All @@ -139,7 +141,7 @@ Once that's done, you'll be serving knossos on `localhost:3000` with hot reloadi

### theseus (launcher)

[theseus] is the Tauri-based launcher that lets users conveniently play any mod or modpack on Modrinth. It uses the Rust-based Tauri as the backend and Nuxt.js as the frontend. To get started, install [pnpm] and [Rust], then run the following commands:
[theseus] is the Tauri-based launcher that lets users conveniently play any mod or modpack on Modrinth. It uses the Rust-based Tauri as the backend and Nuxt.js as the frontend. To get started, install [pnpm], [Rust], and the [Tauri prerequisites](https://tauri.app/v1/guides/getting-started/prerequisites/#installing) for your system. Then, run the following commands:

```bash
cd theseus_gui
Expand Down