Skip to content

docs: expand frontend developer guide#110

Merged
yabirgb merged 1 commit intorotki:mainfrom
kelsos:docs/frontend-developer-guide
Mar 11, 2026
Merged

docs: expand frontend developer guide#110
yabirgb merged 1 commit intorotki:mainfrom
kelsos:docs/frontend-developer-guide

Conversation

@kelsos
Copy link
Member

@kelsos kelsos commented Mar 11, 2026

Summary

  • Expands the sparse working-with-frontend.md (was 5 lines) into a comprehensive frontend developer guide covering all environment variables, the development proxy, workspace structure, Vite configs, and linting/type checking commands
  • Updates build-from-source.md with exact Node.js (>=24 <25) and pnpm (>=10 <11) version requirements, adds Rust/Cargo as a prerequisite, simplifies pnpm install to use corepack, and documents what pnpm run dev actually starts
  • Complements rotki/rotki#11864 which adds the VITE_NO_AUTO_FETCH flag

Test plan

  • Verify VitePress renders the new tables and anchor links correctly
  • Confirm all documented env vars match what exists in frontend/app/.env and import.meta.env usage in the codebase

…, and linting

- Document all frontend environment variables (dev tools, API URLs, feature flags, i18n, test-only)
- Add development proxy section with auto-start behavior, configuration, and endpoint mocking
- Add workspace structure overview and Vite configuration files explanation
- Add linting and type checking commands
- Add environment files reference with example .env.development.local
- Update build-from-source with Node.js/pnpm version requirements and Rust/Cargo prerequisite
- Simplify pnpm installation instructions to use corepack
- Document what `pnpm run dev` starts and link to the frontend guide
Copy link
Member

@yabirgb yabirgb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks kelsos

@yabirgb yabirgb merged commit b0e21c3 into rotki:main Mar 11, 2026
5 checks passed
@kelsos kelsos deleted the docs/frontend-developer-guide branch March 11, 2026 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants