Thank you to everyone that is contributing and to those who want to contribute. Any contribution is welcomed!
Quick guide:
- Fork this project.
- Clone your fork (
git clone <fork-URL>
). - Add main repo as remote (
git remote add upstream <main-repo-URL>
). - Create a branch for your changes (
git switch -c feature/your-feature
orgit switch -c fix/your-fix
). - Commit your changes (
git commit -m "feat(...): ..."
).
- follow Conventional Commits
- Push to your fork (
git push origin <branch-name>
). - Open a PR.
Remembers to always follow the code of conduct.
VSCode + Volar (and disable Vetur).
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.
pnpm install --frozen-lockfile # recommended
pnpm run dev --host # LAN access
pnpm run build