# Codex Project Notes

## Project

`League of Legends GUI Overhaul` is a React/Vite prototype for a modern, dark, MOBA-/fantasy-inspired client interface.

Repository:

```text
Toxic/league-of-legends-gui-overhaul
```

Remote:

```text
https://git.wilkensxl.de/Toxic/league-of-legends-gui-overhaul.git
```

Repository owner and name are derived from this project remote, not from the Agent Kit template repository.

## Commands

Use these commands as the source of truth:

```bash
npm install
npm run dev
npm run lint
npm run build
npm test
npm run audit
npm run release:check
git diff --check
```

`npm run lint` runs `tsc --noEmit`. `npm run audit` checks production dependencies at high severity. `npm run release:check` runs lint, tests, and build.

Build and test verification should run on the Gitea runner with:

```text
.gitea/workflows/build.yml
```

The local machine is not the source of truth for CI results.

## Stack

```text
React, Vite, TypeScript, React Router, Vitest, Testing Library, CSS custom properties.
```

Package manager or build tool:

```text
npm
```

## Build Artifacts

Release artifacts are produced in:

```text
dist/
```

The Gitea build workflow uploads `dist/` as the `league-of-legends-gui-overhaul-dist` workflow artifact.

## Security Rules

- Do not commit secrets, tokens, `.env` files, certificates, or private keys.
- Treat generated credentials as sensitive.
- Prefer local generation and local processing for user data.
- Keep dependency audit results visible in CI once dependencies exist.
- Do not add external network calls unless the feature explicitly requires them.
- Document any external assets, API calls, telemetry, or package publishing behavior when implementation begins.

## Release Rules

No published release process exists yet.

Before a release:

1. run `npm run build`,
2. run `npm test`,
3. run the release checklist,
4. verify CI is green,
5. verify download links when publishing artifacts,
6. update README and changelog,
7. create a tag,
8. create the release.

Do not create releases unless the user explicitly asks for a release.