Files

Calum H. 3adee66899 devex: prepr:web and app with proper caching (#4957 )

* devex: prepr:web and app with proper caching

* fix: add tooling config to turbo global deps

* fix: exclude turbo + node modules for tooling-config

* feat: prepr:frontend

* fix: ci issue

2025-12-24 21:39:59 +00:00

3.3 KiB

Raw Blame History

Architecture

Use TAB instead of spaces.

Frontend

There are two similar frontends in the Modrinth monorepo, the website (apps/frontend) and the app frontend (apps/app-frontend).

Both use Tailwind v3, and their respective configs can be seen at tailwind.config.ts and tailwind.config.js respectively.

Both utilize shared and common components from @modrinth/ui which can be found at packages/ui, and stylings from @modrinth/assets which can be found at packages/assets.

Both can utilize icons from @modrinth/assets, which are automatically generated based on what's available within the icons folder of the packages/assets directory. You can see the generated icons list in generated-icons.ts.

Both have access to our dependency injection framework, examples as seen in packages/ui/src/providers/. Ideally any state which is shared between a page and it's subpages should be shared using this dependency injection framework.

Website (apps/frontend)

Before a pull request can be opened for the website, run pnpm prepr:frontend:web from the root folder, otherwise CI will fail.

To run a development version of the frontend, you must first copy over the relevant .env template file (prod, staging or local, usually prod) within the apps/frontend folder into apps/frontend/.env. Then you can run the frontend by running pnpm web:dev in the root folder.

App Frontend (apps/app-frontend)

Before a pull request can be opened for the app frontend, run pnpm prepr:frontend:app from the root folder, otherwise CI will fail.

To run a development version of the app frontend, you must first copy over the relevant .env template file (prod, staging or local, usually prod) within packages/app-lib into packages/app-lib/.env. Then you must run the app itself by running pnpm app:dev in the root folder.

Localization

Refer to .github/instructions/i18n-convert.instructions.md if the user asks you to perform any i18n conversion work on a component, set of components, pages or sets of pages.

Labrinth

Labrinth is the backend API service for Modrinth.

Testing

Before a pull request can be opened, run cargo clippy -p labrinth --all-targets and make sure there are ZERO warnings, otherwise CI will fail.

Use cargo test -p labrinth --all-targets to test your changes. All tests must pass, otherwise CI will fail.

To prepare the sqlx cache, cd into apps/labrinth and run cargo sqlx prepare. Make sure to NEVER run cargo sqlx prepare --workspace.

Read the root docker-compose.yml to see what running services are available while developing. Use docker exec to access these services.

When the user refers to "performing pre-PR checks", do the following:

Run clippy as described above
DO NOT run tests unless explicitly requested (they take a long time)
Prepare the sqlx cache

Clickhouse

Use docker exec labrinth-clickhouse clickhouse-client to access the Clickhouse instance. We use the staging_ariadne database to store data in testing.

Postgres

Use docker exec labrinth-postgres psql -U labrinth -d labrinth -c "SELECT 1" to access the PostgreSQL instance, replacing the SELECT 1 with your query.

Guidelines

Do not create new non-source code files (e.g. Bash scripts, SQL scripts) unless explicitly prompted to.

3.3 KiB Raw Blame History