Setup¶

Prerequisites¶

To work with the template monorepo you'll need to install these tools.

Pre-commit¶

When contributing to this project, pre-commits are necessary, as they run certain tests, sanitisers, and formatters.

The project provides a .pre-commit-config.yaml file that is used to setup git pre-commit hooks.

On commit locally, code is automatically formatted and checked for security vulnerabilities using pre-commit git hooks.

Installation¶

To initialize pre-commit in your local repository, run

pre-commit install

This tells pre-commit to run for this repository on every commit.

Usage¶

Pre-commit will run on every commit, but can also be run manually on all files:

pre-commit run --all-files

Pre-commit tests can be skipped on commits with git commit --no-verify.

Caution

If you have to skip the pre-commit tests, you're probably doing something you're not supposed to, and whoever commits after you might have to fix your "mistakes". Consider updating the pre-commit hooks if your code is non-compliant.

Hooks¶

Overview

| Repository | Hook | Purpose | |-------------------------------------------------------------------------------------|-------------------------|------------------------------------------------------------------------------------| | [pre-commit/pre-commit-hooks](https://github.com/pre-commit/pre-commit-hooks) | check-ast | Check whether files parse as valid python | | | check-merge-conflict | Check for files that contain merge conflict strings | | | check-case-conflict | Check for files with names that would conflict on a case-insensitive filesystem | | | check-json | Verify syntax of all JSON files | | | check-toml | Verify syntax of all TOML files | | | check-yaml | Verify syntax of all YAML files | | | trailing-whitespace | Trim trailing whitespace | | | mixed-line-ending | Replaces or checks mixed line ending | | | detect-private-key | Checks for the existence of private keys | | [compilerla/conventional-pre-commit](https://github.com/compilerla/conventional-pre-commit) | conventional-pre-commit | A pre-commit hook to check commit messages for Conventional Commits formatting | | [ambv/black](https://github.com/ambv/black) | black | Python code formatter | | [PyCQA/bandit](https://github.com/PyCQA/bandit) | bandit | A security linter designed to find common security issues in Python code | | [econchick/interrogate](https://github.com/econchick/interrogate) | interrogate | Check the code base for missing docstrings | | [hadialqattan/pycln](https://github.com/hadialqattan/pycln) | pycln | Finds and removes unused import statements | | [pycqa/isort](https://github.com/pycqa/isort) | isort | Sort imports alphabetically, and automatically separated into sections and by type | | [local](https://github.com/equinor/template-fastapi-react/blob/main/.pre-commit-config.yaml) | vite-plus-check | Vite+ formatting, lint, import boundaries, TanStack Query rules and type checks | | [pycqa/flake8](https://gitlab.com/pycqa/flake8) | flake8 | Check the style and quality of Python code | | [local](https://github.com/equinor/template-fastapi-react/blob/main/.pre-commit-config.yaml) | mypy | Python type checker | | | pytest | Python test runner | | | | |

API¶

From inside the /api folder.

Install `uv`¶

uv is used to manage Python package dependencies.

$ pip install uv

The installation instructions can be found here.

Install packages¶

$ uv sync --dev

Web¶

From inside the /web folder.

Package management¶

This project uses pnpm and Vite+, pinned in web/package.json and web/pnpm-workspace.yaml. mise installs Node 24.22.2 and pnpm; a global vp installation is not needed. After cloning or switching branches, install the locked dependencies for editors and direct pnpm commands:

mise install
mise run install-dependencies:web

The mise run lint:web, test:web, build:web, and API-client generation tasks install web dependencies automatically.

Editors¶

Dependencies use standard web/node_modules resolution. Remove old Yarn PnP SDK settings from your editor. For VSCode, select the workspace TypeScript installation at web/node_modules/typescript/lib; in JetBrains IDEs, select pnpm as the package manager and web/node_modules/typescript as the TypeScript package.

Use the Oxc editor extension for formatting and linting. Configuration lives in web/vite.config.ts, not separate ESLint or Biome files. Repository-local editor settings are intentionally untracked.

Run mise run lint:web for formatting, lint and both native TypeScript checks and the TypeScript 6 compiler check. The latter remains available because OpenAPI generation still requires the JavaScript compiler API removed in TypeScript 7.