Skip to content

Latest commit

 

History

History
47 lines (35 loc) · 1.81 KB

File metadata and controls

47 lines (35 loc) · 1.81 KB

AGENTS.md Instructions

This project is the official website of REVATI. REVATI (revati.jp) is a multi-gaming and esports organization based in Japan.

This website supports Japanese, English, and Korean languages. Localization is managed via ja.json, en.json, and ko.json files located in the src/lib/scripts/i18n/locales/ directory.

Technical Stack

Commands

  • Clean install: pnpm install --frozen-lockfile
  • Install deps: pnpm install
  • Start dev server: pnpm run dev
    • pnpm run licenses to update licenses data
  • Build: pnpm run build
  • Check & format & lint: pnpm run check && pnpm run format && pnpm run lint

Code Style

  • Use TypeScript strict mode.
    • Use === and !== (Strict Equality).
    • No implicit booleans in conditionals (e.g., if (0 < count) or if (user !== null)).
  • Use SCSS instead of Vanilla CSS.
    • src/lib/stylesheets/variables/ directory contains utility SCSS files _color.scss, _mixin.scss, and _dimension.scss. To use them in SCSS files or <style lang="scss"> blocks, import as @use '$lib/stylesheets/variables/color' as *;.
  • Follow the Svelte 5 best practices.

Other Instructions

  • When using the z-index property, ensure you update the Z-Index list in docs/SPECIFICATION.md.
  • When adding new CSS variables (not Sass variables), ensure you update the CSS Variable list in docs/SPECIFICATION.md.

Other Docs

  • docs/SPECIFICATION.md:
    • Z-Index list
    • CSS Variable list (not Sass variables)
    • Font list
    • API Endpoint list