From 5366980e8577c3490f960812034b02537b5e5c44 Mon Sep 17 00:00:00 2001 From: dotnetCarpenter Date: Sat, 17 Mar 2018 17:40:14 +0100 Subject: [PATCH 1/2] be more specific about what it takes to start developing on nuxt --- CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4f0d27d974..0569303d5d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,8 +3,11 @@ 1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device. 2. Install the dependencies: `npm install`. 3. Run `npm link` to link the local repo to NPM. -4. Run `nuxt build` to build or `nuxt` to build and watch for code changes. -5. Then npm link this repo inside any example app with `npm link nuxt`. -6. 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). +4. `nuxt build` to build and `nuxt` to build and watch for code changes are now globally available but only works inside a nuxt project. +5. Then npm link this repo inside any nuxt example app with `npm link nuxt`. +6. Run `nuxt build` or `nuxt` inside your example app. +7. 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 has 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. From 2bf53e6ee34e21e9958d703f011b45c5d9b75273 Mon Sep 17 00:00:00 2001 From: dotnetCarpenter Date: Mon, 19 Mar 2018 19:21:51 +0100 Subject: [PATCH 2/2] updated README with 'npm run' info in nuxt app example --- CONTRIBUTING.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0569303d5d..4bcd9cf9b8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,10 +3,9 @@ 1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device. 2. Install the dependencies: `npm install`. 3. Run `npm link` to link the local repo to NPM. -4. `nuxt build` to build and `nuxt` to build and watch for code changes are now globally available but only works inside a nuxt project. -5. Then npm link this repo inside any nuxt example app with `npm link nuxt`. -6. Run `nuxt build` or `nuxt` inside your example app. -7. 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). +4. Then npm link this repo inside any nuxt example app with `npm link nuxt`. +5. Run `npm run build` or `npm run dev` inside your example app, if you created it with [nuxt starter template](https://github.com/nuxt-community/starter-template). +6. 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 has 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._