Merge pull request coderoad#295 from coderoad/dev-docs

ShMcK · web-flow · commit 7a56f9e048f7 · 2020-04-19T16:36:19.000-07:00
update dev docs
diff --git a/README.md b/README.md
@@ -46,8 +46,25 @@ See an [interactive visualization](https://coderoad.github.io/coderoad-visual/)
 
 Tutorials can be edited directly as markdown on Github.
 
+## Development
+
+To run the extension locally:
+
+- copy environmental variables from `/web-app/.env.example` as `/web-app/.env`
+- install dependencies with `yarn install-all`
+- build the extension with `yarn build`
+- open the extension with the vscode extension debugger by pressing F5. In the new window, open CodeRoad.
+
+To test a packaged build locally:
+
+- if on Mac, ensure you have [VSCode command line tools](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line) installed
+- run `yarn package`. It will build the extension and install it locally.
+- open a new vscode window and launch the new version of CodeRoad
+
 ## Contributing
 
+CodeRoad is an ambitious project, we're always looking for contributors :)
+
 See [CONTRIBUTING.md](./CONTRIBUTING.md).
 
 ## License
diff --git a/package.json b/package.json
@@ -26,10 +26,10 @@
   "scripts": {
     "build": "./scripts/build.sh",
     "postinstall": "node ./node_modules/vscode/bin/install",
-    "install-all": "yarn && cd web-app && yarn",
+    "install-all": "yarn && yarn --cwd web-app",
     "lint": "eslint src/**/*ts",
     "package": "./scripts/package.sh",
-    "storybook": "cd web-app && npm run storybook",
+    "storybook": "yarn --cwd web-app storybook",
     "test": "jest",
     "watch": "tsc -watch -p ./"
   },
diff --git a/scripts/build.sh b/scripts/build.sh
@@ -12,7 +12,7 @@ tsc -p ./
 
 # build web app
 cd web-app
-npm run build
+yarn build
 cd ..
 
 # For Windows build: switch the next 2 lines
diff --git a/web-app/.yarn-integrity b/web-app/.yarn-integrity
