-
Notifications
You must be signed in to change notification settings - Fork 405
docs: update contribution pages #5608
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
tdgao
wants to merge
4
commits into
main
Choose a base branch
from
truman/update-docs-contribution-pages
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,15 @@ | ||
| --- | ||
| title: Daedalus (Metadata service) | ||
| description: Guide for contributing to Modrinth's frontend | ||
| sidebar: | ||
| order: 5 | ||
| --- | ||
|
|
||
| Daedalus is a powerful tool which queries and generates metadata for the Minecraft (and other games in the future!) game | ||
| and mod loaders for: | ||
|
|
||
| - Performance (Serving static files can be easily cached and is extremely quick) | ||
| - Ease for Launcher Devs (Metadata is served in an easy to query and use format) | ||
| - Reliability (Provides a versioning system which ensures no breakage with updates) | ||
|
|
||
| Daedalus supports the original Minecraft data and reposting for the Forge, Fabric, Quilt, and NeoForge loaders. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,32 @@ | ||
| --- | ||
| title: Knossos (Frontend) | ||
| title: Modrinth Website | ||
| description: Guide for contributing to Modrinth's frontend | ||
| sidebar: | ||
| order: 2 | ||
| --- | ||
|
|
||
| This project is part of our [monorepo](https://github.com/modrinth/code). You can find it in the `apps/frontend` directory. | ||
| The [Modrinth Website], codename Knossos, is a Nuxt.js frontend. You will need to install [pnpm] and run the standard commands: | ||
|
|
||
| [knossos] is the Nuxt.js frontend. You will need to install [pnpm] and run the standard commands: | ||
| ## Setup | ||
|
|
||
| ```bash | ||
| pnpm install | ||
| pnpm run web:dev | ||
| ``` | ||
| ### 1. Install prerequisites | ||
|
|
||
| Once that's done, you'll be serving knossos on `localhost:3000` with hot reloading. You can replace the `dev` in `pnpm run dev` with `build` to build for a production server and `start` to start the server. You can also use `pnpm run lint` to find any eslint problems, and `pnpm run fix` to try automatically fixing those problems. | ||
| - Install the package manager [pnpm](https://pnpm.io/) | ||
|
|
||
| <details> | ||
| <summary>.env variables & command line options</summary> | ||
| ### 2. Install dependencies & set up .env | ||
|
|
||
| #### Basic configuration | ||
| - Clone [`https://github.com/modrinth/code`](https://github.com/modrinth/code) and run `pnpm install` in the workspace root folder. | ||
| - In `apps/frontend` you should be able to see `.env.prod`, `.env.staging` — for basic work, it's recommended to use `.env.prod`. Copy the relevant file into a new `.env` file within the `apps/frontend` folder. | ||
|
|
||
| `SITE_URL`: The URL of the site (used for auth redirects). Default: `http://localhost:3000` | ||
| `BASE_URL`: The base URL for the API. Default: `https://staging-api.modrinth.com/v2/` | ||
| `BROWSER_BASE_URL`: The base URL for the API used in the browser. Default: `https://staging-api.modrinth.com/v2/` | ||
| ### 3. Run the frontend | ||
|
|
||
| </details> | ||
| - Run `pnpm web:dev` in the workspace root folder. Once that's done, you'll be serving the website on `localhost:3000` with hot reloading. | ||
|
|
||
| #### Ready to open a PR? | ||
| ## Ready to open a PR? | ||
|
|
||
| If you're prepared to contribute by submitting a pull request, ensure you have met the following criteria: | ||
|
|
||
| - `pnpm run fix` has been run. | ||
| - `pnpm prepr:frontend` has been run. | ||
|
|
||
| [knossos]: https://github.com/modrinth/code/tree/main/apps/frontend | ||
| [Modrinth website]: https://github.com/modrinth/code/tree/main/apps/frontend | ||
| [pnpm]: https://pnpm.io |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.