diff --git a/template/README.md b/template/README.md index a04d00ba..a092da15 100644 --- a/template/README.md +++ b/template/README.md @@ -81,18 +81,22 @@ Please be sure to review the [contribution guidelines](https://auro.alaskaair.co ### Start development environment -Once the project has been cloned to your local resource and you have installed all the dependencies you will need to open two different shell sessions. One is for the **npm tasks**, the second is to run the **server**. +Once the project has been cloned to your local resource and you have installed all the dependencies you will need to open a shell session to run the **dev server**. ```shell -// shell terminal one $ npm run dev - -// shell terminal two -$ npm run serve ``` Open [localhost:8000](http://localhost:8000/) +If running separate sessions is preferred, please run the following commands in individual terminal shells. + +```shell +$ npm run build:watch + +$ npm run serve +``` + ### API generation The custom element API file is generated in the build and committed back to the repo with a version change. If the API doc has changed without a version change, author's are to run `npm run build:api` to generate the doc and commit to version control. diff --git a/template/README__labs.md b/template/README__labs.md index abec917e..b6a3c5ab 100644 --- a/template/README__labs.md +++ b/template/README__labs.md @@ -74,18 +74,22 @@ Please be sure to review the [contribution guidelines](https://auro.alaskaair.co ### Start development environment -Once the project has been cloned to your local resource and you have installed all the dependencies you will need to open two different shell sessions. One is for the **npm tasks**, the second is to run the **server**. +Once the project has been cloned to your local resource and you have installed all the dependencies you will need to open a shell session to run the **dev server**. ```shell -// shell terminal one $ npm run dev - -// shell terminal two -$ npm run serve ``` Open [localhost:8000](http://localhost:8000/) +If running separate sessions is preferred, please run the following commands in individual terminal shells. + +```shell +$ npm run build:watch + +$ npm run serve +``` + ### API generation The custom element API file is generated in the build and committed back to the repo with a version change. If the API doc has changed without a version change, author's are to run `npm run build:api` to generate the doc and commit to version control. diff --git a/template/index.html b/template/index.html index b9e3ffb1..dc0cbbfb 100644 --- a/template/index.html +++ b/template/index.html @@ -9,7 +9,7 @@ diff --git a/template/package.json b/template/package.json index 12d686f9..b1d7a8e2 100644 --- a/template/package.json +++ b/template/package.json @@ -3,8 +3,7 @@ "================================================================================", "# To work within the development environment, run the following tasks", " 1. $ npm run dev", - " 2. $ npm run serve", - " 3. Go to http://localhost:8000", + " 2. Go to http://localhost:8000", "================================================================================" ], "name": "[npm]/[namespace]-[name]", @@ -53,6 +52,7 @@ "babel-loader": "", "compression": "", "concat": "", + "concurrently": "", "copyfiles": "", "core-js": "", "eslint": "", @@ -155,7 +155,7 @@ "demo:new:build": "mkdir ./build && mkdir ./build/css && mkdir ./build/demo", "demo:rm:build": "rm -rf ./build", "demo:update:index": "node ./scripts/prepForBuild", - "dev": "npm run build:watch", + "dev": "concurrently --kill-others 'npm run build:watch' 'npm run serve'", "dist:js": "copyfiles -u 1 -V './src/**/*.js' ./dist", "esLint": "./node_modules/.bin/eslint src/**/*.js", "linters": "npm-run-all scssLint esLint",