mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-05 21:53:56 +00:00
1.1 KiB
1.1 KiB
Contributing to Nuxt.js
- Fork this repository to your own GitHub account and then clone it to your local device.
- Run
npm install
to install the dependencies. - Run
npm link
to link the local repository to NPM. - Then npm links this repository inside any nuxt example app with
npm link nuxt
. - Run
npm run build
ornpm run dev
inside your example app, if you created it with nuxt starter template. - Then you can run your example app with the local version of Nuxt.js (You may need to re-run the example app as you change server side code in the Nuxt.js repository).
Note that both npm and yarn have been seen to miss installing dependencies. To remedy that, you can either delete the node_modules folder in your example app and install again or do a local install of the missing dependencies.
Make sure to add tests into test/
directory and try them with npm test
before making a pull request.