Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

58 lines (40 loc) · 1.29 KB
Raw

Contributions welcome!

1. Install

git clone git@github.com:vikejs/vike-vue
cd vike-vue/
pnpm install

Note

See System requirements for how to install pnpm.

2. Build

Build all packages/*:

pnpm build

3. Develop

Watch & re-build upon modifications:

cd packages/vike-vue # or any other packages/*
pnpm dev

In a second shell:

cd examples/full/ # or any other examples/*
pnpm dev

That's it. You can now test your modifications.

Warning

After changing the source code of vike-vue(-*), make sure to always clear Vite's client cache with $ rm -rf examples/full/node_modules/.vite/. Otherwise you'll get a version mismatch between the server (using the latest build) and the client (using the previous cached build).

Warning

When switching Git branches, make sure to run pnpm reset at the monorepo root: it will re-install and re-build everything. It's required when switching to a branch that, for example, requires another Vike version.


System requirements

  • Node.js >=16.0.0
  • pnpm >=9.0.0

Note

To install pnpm run:

npm install -g pnpm

(Or see pnpm Docs > Installation for alternative methods.)