diff --git a/.github/assets/api_client_cover.png b/.github/assets/api_client_cover.png new file mode 100644 index 00000000000..46b007b9b41 Binary files /dev/null and b/.github/assets/api_client_cover.png differ diff --git a/.github/assets/api_client_cover_light.png b/.github/assets/api_client_cover_light.png new file mode 100644 index 00000000000..872fb01126c Binary files /dev/null and b/.github/assets/api_client_cover_light.png differ diff --git a/.github/assets/api_cover.png b/.github/assets/api_cover.png index 5de90400836..fb651f46dee 100644 Binary files a/.github/assets/api_cover.png and b/.github/assets/api_cover.png differ diff --git a/.github/assets/api_cover_light.png b/.github/assets/api_cover_light.png new file mode 100644 index 00000000000..2cc8912a568 Binary files /dev/null and b/.github/assets/api_cover_light.png differ diff --git a/.github/assets/app_cover.png b/.github/assets/app_cover.png index 5f98efe30a7..e417d873a65 100644 Binary files a/.github/assets/app_cover.png and b/.github/assets/app_cover.png differ diff --git a/.github/assets/app_cover_light.png b/.github/assets/app_cover_light.png new file mode 100644 index 00000000000..609e60c756f Binary files /dev/null and b/.github/assets/app_cover_light.png differ diff --git a/.github/assets/docs_cover.png b/.github/assets/docs_cover.png new file mode 100644 index 00000000000..74a7ba9d7bd Binary files /dev/null and b/.github/assets/docs_cover.png differ diff --git a/.github/assets/docs_cover_light.png b/.github/assets/docs_cover_light.png new file mode 100644 index 00000000000..3407f7fa2a5 Binary files /dev/null and b/.github/assets/docs_cover_light.png differ diff --git a/.github/assets/meta_cover.png b/.github/assets/meta_cover.png new file mode 100644 index 00000000000..0231c4be369 Binary files /dev/null and b/.github/assets/meta_cover.png differ diff --git a/.github/assets/meta_cover_light.png b/.github/assets/meta_cover_light.png new file mode 100644 index 00000000000..9569c6c2a1d Binary files /dev/null and b/.github/assets/meta_cover_light.png differ diff --git a/.github/assets/monorepo_cover.png b/.github/assets/monorepo_cover.png index f768e4ddb66..fd455c74692 100644 Binary files a/.github/assets/monorepo_cover.png and b/.github/assets/monorepo_cover.png differ diff --git a/.github/assets/monorepo_cover_light.png b/.github/assets/monorepo_cover_light.png new file mode 100644 index 00000000000..35b270d397e Binary files /dev/null and b/.github/assets/monorepo_cover_light.png differ diff --git a/.github/assets/social_preview.png b/.github/assets/social_preview.png new file mode 100644 index 00000000000..90e0cbd92aa Binary files /dev/null and b/.github/assets/social_preview.png differ diff --git a/.github/assets/ui_cover.png b/.github/assets/ui_cover.png new file mode 100644 index 00000000000..56bd7179c0b Binary files /dev/null and b/.github/assets/ui_cover.png differ diff --git a/.github/assets/ui_cover_light.png b/.github/assets/ui_cover_light.png new file mode 100644 index 00000000000..07fbdd59b83 Binary files /dev/null and b/.github/assets/ui_cover_light.png differ diff --git a/.github/assets/web_cover.png b/.github/assets/web_cover.png index 5c922277c10..94cdbcc3ad3 100644 Binary files a/.github/assets/web_cover.png and b/.github/assets/web_cover.png differ diff --git a/.github/assets/web_cover_light.png b/.github/assets/web_cover_light.png new file mode 100644 index 00000000000..b9a6d6b1cd6 Binary files /dev/null and b/.github/assets/web_cover_light.png differ diff --git a/COPYING.md b/COPYING.md index 1095384f854..6dec002abbb 100644 --- a/COPYING.md +++ b/COPYING.md @@ -8,14 +8,11 @@ For detailed information, consult each package's COPYING.md, LICENSE.txt, or LIC The use of Modrinth branding elements, including but not limited to the wrench-in-labyrinth logo, the landing image, and any variations thereof, is strictly prohibited without explicit written permission from Rinth, Inc. This includes trademarks, logos, or other branding elements. -> All rights reserved. © 2020-2025 Rinth, Inc. +> All rights reserved. © 2020-2026 Rinth, Inc. -This includes, but may not be limited to, the following files: +This includes, but may not be limited to, the following files or directories: - .idea/icon.svg -- .github/api_cover.png -- .github/app_cover.png -- .github/monorepo_cover.png -- .github/web_cover.png +- .github/assets/ If you fork this repository, you must remove all Modrinth branding assets from your fork. diff --git a/README.md b/README.md index 0def9bf509f..0cd259c4927 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ -# ![Modrinth Monorepo Cover](/.github/assets/monorepo_cover.png) + + + Modrinth Monorepo Cover + ![Issues](https://img.shields.io/github/issues-raw/Modrinth/code?color=c78aff&label=issues&style=for-the-badge) ![Pull Requests](https://img.shields.io/github/issues-pr-raw/Modrinth/code?color=c78aff&label=PRs&style=for-the-badge) @@ -9,16 +12,23 @@ ## Modrinth Monorepo -Welcome to the Modrinth Monorepo, the primary codebase for the Modrinth web interface and app. It contains ![Lines of code](https://img.shields.io/endpoint?url=https://loctopus.creeperkatze.dev/github/modrinth/code/badge%3Fformat%3Dhuman&logoColor=white&color=black&label=) lines of code and has ![Contributors](https://img.shields.io/github/contributors/Modrinth/code?color=black&label=) contributors! +Welcome to the Modrinth Monorepo, the primary codebase for the Modrinth website, app, API and documentation. It contains ![Lines of code](https://img.shields.io/endpoint?url=https://loctopus.creeperkatze.dev/github/modrinth/code/badge%3Fformat%3Dhuman&logoColor=white&color=black&label=) lines of code and has ![Contributors](https://img.shields.io/github/contributors/Modrinth/code?color=black&label=) contributors! If you're not a developer and you've stumbled upon this repository, you can access the web interface on the [Modrinth website](https://modrinth.com) and download the latest release of the app [here](https://modrinth.com/app). ## Development -This repository contains two primary packages. For detailed development information, please refer to their respective guides: +This repository contains several projects. For detailed development information, please refer to their respective guides: -- [Website frontend](https://docs.modrinth.com/contributing/knossos/) -- [Desktop app](https://docs.modrinth.com/contributing/theseus/) +| Project | Directory | Guide | +| ------------- | ---------------------- | --------------------------------------------------------- | +| Website | `apps/frontend` | [Guide](https://docs.modrinth.com/contributing/knossos/) | +| App | `apps/app` | [Guide](https://docs.modrinth.com/contributing/theseus/) | +| API | `apps/labrinth` | [Guide](https://docs.modrinth.com/contributing/labrinth/) | +| Meta | `apps/daedalus_client` | [Guide](https://docs.modrinth.com/contributing/daedalus/) | +| Documentation | `apps/docs` | [Guide](https://docs.modrinth.com/contributing/docs/) | + +Shared libraries live in `packages/`. ## Contributing @@ -36,4 +46,4 @@ If you need help with the Modrinth web interface or app, please visit our [suppo ## License -All packages in this repository are licensed under their respective licenses. Refer to the LICENSE file in each package for more information. +All packages in this repository are licensed under their respective licenses. See the [copying guidelines](COPYING.md) for details, including restrictions on Modrinth branding. diff --git a/apps/app/README.md b/apps/app/README.md index 298a7dced8e..b603fc21af6 100644 --- a/apps/app/README.md +++ b/apps/app/README.md @@ -1,4 +1,7 @@ -# ![Modrinth App](/.github/assets/app_cover.png) + + + Modrinth App Cover + ## Modrinth App diff --git a/apps/daedalus_client/README.md b/apps/daedalus_client/README.md index 43f2b945d5f..8ce08fd5297 100644 --- a/apps/daedalus_client/README.md +++ b/apps/daedalus_client/README.md @@ -1,3 +1,8 @@ + + + Modrinth Meta Cover + + # Daedalus Daedalus is a powerful tool which queries and generates metadata for the Minecraft (and other games in the future!) game diff --git a/apps/docs/README.md b/apps/docs/README.md index 6cebf2a93d2..d3aff43b2d6 100644 --- a/apps/docs/README.md +++ b/apps/docs/README.md @@ -1,3 +1,8 @@ + + + Modrinth Docs Cover + + # Modrinth Documentation Welcome to the Modrinth documentation! diff --git a/apps/frontend/README.md b/apps/frontend/README.md index f7d2adbe36f..05fa8bc3a65 100644 --- a/apps/frontend/README.md +++ b/apps/frontend/README.md @@ -1,4 +1,7 @@ -# ![Frontend Cover](/.github/assets/web_cover.png) + + + Modrinth Website Cover + # Modrinth Web Interface diff --git a/apps/labrinth/README.md b/apps/labrinth/README.md index 6377ee2f2fd..91bcb0dfc46 100644 --- a/apps/labrinth/README.md +++ b/apps/labrinth/README.md @@ -1,4 +1,7 @@ -![labrinth banner](/.github/assets/api_cover.png) + + + Modrinth API Cover + ## Modrinth's laboratory for its backend service & API! diff --git a/packages/api-client/README.md b/packages/api-client/README.md index 8ae1bedbd28..1eb66c3ffe6 100644 --- a/packages/api-client/README.md +++ b/packages/api-client/README.md @@ -1,3 +1,8 @@ + + + Modrinth API Client Cover + + # @modrinth/api-client [![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-c78aff?style=for-the-badge)](https://www.typescriptlang.org/) diff --git a/packages/daedalus/README.md b/packages/daedalus/README.md index 346d89809e4..9dcf9b9f17a 100644 --- a/packages/daedalus/README.md +++ b/packages/daedalus/README.md @@ -1,3 +1,8 @@ + + + Modrinth Meta Cover + + # Daedalus Daedalus (the rust library) is a library providing model structs and methods for requesting and parsing things diff --git a/packages/ui/README.md b/packages/ui/README.md new file mode 100644 index 00000000000..acf536d81f6 --- /dev/null +++ b/packages/ui/README.md @@ -0,0 +1,36 @@ + + + Modrinth UI Cover + + +# @modrinth/ui + +The shared Vue 3 component library used by both the [Modrinth Website](../../apps/frontend) and the [Modrinth App](../../apps/app-frontend). Components are platform-agnostic, with platform-specific behavior provided through dependency injection. + +## Structure + +``` +src/ +├── components/ # Vue components, grouped by feature +├── composables/ # Composition API hooks +├── layouts/ # Page layouts shared between the website and app +├── providers/ # Dependency injection contexts +├── utils/ # Utility functions and constants +├── locales/ # Translations +├── styles/ # Tailwind CSS utilities +└── stories/ # Storybook stories +``` + +Everything public is re-exported from [`index.ts`](./index.ts). + +## Development + +Browse and develop components in isolation with Storybook, from the repository root: + +```bash +pnpm storybook +``` + +## License + +Licensed under the GNU General Public License v3. Modrinth branding is excluded, see [COPYING.md](./COPYING.md) for details.