Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 1.64 KB

README.md

File metadata and controls

55 lines (36 loc) · 1.64 KB
Raw

frontend

Contributing

Thank you to everyone that is contributing and to those who want to contribute. Any contribution is welcomed!

Quick guide:

  1. Fork this project.
  2. Clone your fork (git clone <fork-URL>).
  3. Add main repo as remote (git remote add upstream <main-repo-URL>).
  4. Create a branch for your changes (git switch -c feature/your-feature or git switch -c fix/your-fix).
  5. Commit your changes (git commit -m "feat(...): ...").
  1. Push to your fork (git push origin <branch-name>).
  2. Open a PR.

Remembers to always follow the code of conduct.

Recommended IDE Setup

VSCode + Volar (and disable Vetur).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need Volar to make the TypeScript language service aware of .vue types.

Project Setup

pnpm install --frozen-lockfile # recommended

Compile and Hot-Reload for Development

pnpm run dev --host # LAN access

Type-Check, Compile and Minify for Production

pnpm run build